SearchClientsByRoleNamesRequest

Search OAuth Applications (clients) by roles and/or resource.

Properties

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”.

RolesSearchTermDto

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_MATCH , CONTAINS , STARTS_WITH , ENDS_WITH

JSON Example

{
	"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 Organization Clients By Role Names

SearchClientsByRoleNamesRequest

Properties

JSON Example

Parameter To

Was this page helpful?