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

Search Organization Users By Organization ID And Roles Search Term

Description

Search all users who have at least one of the specified roles and/or resource.
Search by resource can be exact match or by resource starting with given term. At most one of the filters resource or resourceStartsWith may be provided.
For all users found by these search criteria the result contains all users roles, no matter if they are part of the search criteria or not.
To search by resource starting with given term provide resourceStartsWith.
If resource is empty then unscoped role assignments will be returned.
When role is provided and resource is null all role assignments will be returned.
When filterResults flag is true the result is filtered by search parameters from the request: resource, resourceStartsWith and roles names.
In this case the result contains just the roles that match the search criteria.
Paginated results - by default start index of results is 1 and default number of search results per page is 200.
Searching access restricted to Organization Owners, Read-only operators and Service Owners (for organizations that have access to the service).

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Owner ✔️ ✔️

Request

Request

URL

URL


post
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/users/search
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Query Parameters

Query Parameters

boolean
filterResults Optional

Indicates if the response should be filtered by search parameters from the request: resource, resourceStartsWith and roles names (default: false).

Parameter Serialization Style: form Explode:true

Request Body

Request Body

SearchUsersByRolesRequest of mimetype application/json Required
{
	"expandProfile": false,
	"includeGroupIdsInRoles": false,
	"pageLimit": 0,
	"pageStart": 0,
	"resource": "string",
	"resourceStartsWith": "string",
	"rolesSearchTerm": {
		"customRoles": [
			{
				"roleName": "string"
			}
		],
		"orgRoles": [
			{
				"roleName": "string"
			}
		],
		"serviceRoles": [
			{
				"serviceDefinitionId": "string",
				"serviceRoles": [
					{
						"roleName": "string"
					}
				]
			}
		]
	},
	"searchType": "EXACT_MATCH",
	"userSearchTerm": "string"
}
boolean
expandProfile Optional

Indicates if the response should be expanded with the user profile (default: false).


boolean
includeGroupIdsInRoles Optional

Indicates if the inherited roles in the response should indicate group information (default: false).


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


string
userSearchTerm Optional

The string to be searched within email or firstName or lastName or username. If it contains space separated terms, then the searchTerm is matched against possible firstName and lastName combinations. This search term is case insensitive.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK returns PagedPostResponseExpandedTypedUserDto of type application/json
{
	"itemsPerPage": 25,
	"results": [
		{
			"customRoles": [
				{
					"createdBy": "string",
					"createdDate": "string",
					"expiresAt": 3609941597,
					"lastUpdatedBy": "string",
					"lastUpdatedDate": "string",
					"membershipType": "DIRECT",
					"name": "string",
					"resource": "string"
				}
			],
			"orgId": "string",
			"organizationRoles": [
				{
					"createdBy": "string",
					"createdDate": "string",
					"displayName": "string",
					"expiresAt": 3609941597,
					"groupIds": [
						"string"
					],
					"groups": [
						{
							"description": "string",
							"displayName": "string",
							"domain": "string",
							"groupType": "USER_GROUP",
							"id": "string",
							"ownerOrgId": "string",
							"sharedOrgIds": [
								"string"
							],
							"usersCount": 0
						}
					],
					"lastUpdatedBy": "string",
					"lastUpdatedDate": "string",
					"membershipType": "DIRECT",
					"name": "string",
					"resource": "string"
				}
			],
			"serviceRoles": [
				{
					"serviceDefinitionId": "string",
					"serviceRoleNames": [
						"string"
					],
					"serviceRoles": [
						{
							"createdBy": "string",
							"createdDate": "string",
							"expiresAt": 3609941597,
							"groupIds": [
								"string"
							],
							"groups": [
								{
									"description": "string",
									"displayName": "string",
									"domain": "string",
									"groupType": "USER_GROUP",
									"id": "string",
									"ownerOrgId": "string",
									"sharedOrgIds": [
										"string"
									],
									"usersCount": 0
								}
							],
							"lastUpdatedBy": "string",
							"lastUpdatedDate": "string",
							"membershipType": "DIRECT",
							"name": "string",
							"resource": "string"
						}
					]
				}
			],
			"user": {
				"accessible": false,
				"acct": "string",
				"domain": "string",
				"email": "string",
				"firstName": "string",
				"idpId": "string",
				"lastName": "string",
				"userId": "string",
				"userProfile": {
					"alternativeEmail": "string",
					"language": "string",
					"locale": "string"
				},
				"username": "string"
			}
		}
	],
	"startIndex": 5,
	"totalResults": 2000
}
integer as int32
itemsPerPage Optional

Number of items per page.


results Optional

Partial list of returned results.


integer as int32
startIndex Optional

Start index of the results.


integer as int32
totalResults Optional

Total number of results if available

Errors

Errors

400

At least one role search term must be specified


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Organization with this identifier is not found.


409

The request could not be processed due to a conflict


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"expandProfile":false,"includeGroupIdsInRoles":false,"pageLimit":0,"pageStart":0,"resource":"string","resourceStartsWith":"string","rolesSearchTerm":{"customRoles":[{"roleName":"string"}],"orgRoles":[{"roleName":"string"}],"serviceRoles":[{"serviceDefinitionId":"string","serviceRoles":[{"roleName":"string"}]}]},"searchType":"EXACT_MATCH","userSearchTerm":"string"}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/users/search
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2


Feedback

Was this page helpful?