[{"label":"Latest (v1.0)","version":"latest"}]
csp

SearchGroupsByRolesRequest

Search groups by roles and/or resource


Properties

string
groupSearchTerm Optional

The string to be searched within group’s display name.


integer as int32
pageLimit Optional

Maximum number to return in response. Default value is 200.


integer as int32
pageStart Optional

Start index for querying. Default value is 1.


string
resource Optional

Resource to search for resource-scoped role assignments.


string
resourceStartsWith Optional

Resource to search for resource-scoped role assignments starting with given term. This field is deprecated. Consider using “resource” along with “searchType”.


rolesSearchTerm Optional

Defines the roles properties which are used for search.


string
searchType Optional

Defines the searching capability of the “resource” field value.

Possible values are: EXACT_MATCHCONTAINSSTARTS_WITHENDS_WITH

JSON Example

{
	"groupSearchTerm": "string",
	"pageLimit": 0,
	"pageStart": 0,
	"resource": "string",
	"resourceStartsWith": "string",
	"rolesSearchTerm": {
		"customRoles": [
			{
				"roleName": "string"
			}
		],
		"orgRoles": [
			{
				"roleName": "string"
			}
		],
		"serviceRoles": [
			{
				"serviceDefinitionId": "string",
				"serviceRoles": [
					{
						"roleName": "string"
					}
				]
			}
		]
	},
	"searchType": "EXACT_MATCH"
}
[{"label":"Latest (v1.0)","version":"latest"}]
csp
Parameter To

Search Groups Within Organization By Organization ID And Group Roles

Feedback

Was this page helpful?