Get Users In Organization By Organization Id And User Search Term Using GET
Search users in organization having username, firstName, lastName or email which "contains" search term.
e.g. search for "test" will return [email protected] if [email protected] is part of the organization.
Search results limited to first 20 results. Please refine the search term for accurate results.
Organization members will receive basic user information. Organization owners and Service Owners (for organizations that have access to the service) will additionally receive role details of the users.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Member | ✔️ | ✔️ |
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Unique identifier (GUID) of the organization.
The string to be searched within email or firstName or lastName or username.Max search length is 120 characters.
Indicates if the response should be expanded with the user profile; the value is ignored, only the existence of parameter is checked.
Indicates if the response should exclude the user roles; the value is ignored, only the existence of parameter is checked.
Indicates if the inherited roles in the response should indicate group information; the value is ignored, only the existence of parameter is checked.
OK
{
"results": [
{
"user": {
"firstName": "string",
"lastName": "string",
"userProfile": {
"locale": "string",
"language": "string",
"alternativeEmail": "string"
},
"userId": "string",
"email": "string",
"acct": "string",
"domain": "string",
"accessible": false,
"username": "string",
"idpId": "string"
},
"organizationRoles": [
{
"displayName": "string",
"name": "string",
"resource": "string",
"createdBy": "string",
"lastUpdatedDate": "string",
"expiresAt": 3609941597,
"groups": [
{
"domain": "string",
"displayName": "string",
"id": "string",
"ownerOrgId": "string",
"sharedOrgIds": [
"string"
],
"groupType": "string",
"usersCount": 0,
"description": "string"
}
],
"createdDate": "string",
"membershipType": "string",
"groupIds": [
"string"
],
"lastUpdatedBy": "string"
}
],
"serviceRoles": [
{
"serviceRoleNames": [
"string"
],
"serviceDefinitionId": "string",
"serviceRoles": [
{
"name": "string",
"resource": "string",
"createdBy": "string",
"lastUpdatedBy": "string",
"expiresAt": 3609941597,
"groups": [
{
"domain": "string",
"displayName": "string",
"id": "string",
"ownerOrgId": "string",
"sharedOrgIds": [
"string"
],
"groupType": "string",
"usersCount": 0,
"description": "string"
}
],
"createdDate": "string",
"membershipType": "string",
"groupIds": [
"string"
],
"lastUpdatedDate": "string"
}
]
}
],
"customRoles": [
{
"name": "string",
"resource": "string",
"createdBy": "string",
"lastUpdatedBy": "string",
"expiresAt": 3609941597,
"groups": [
{
"domain": "string",
"displayName": "string",
"id": "string",
"ownerOrgId": "string",
"sharedOrgIds": [
"string"
],
"groupType": "string",
"usersCount": 0,
"description": "string"
}
],
"createdDate": "string",
"membershipType": "string",
"groupIds": [
"string"
],
"lastUpdatedDate": "string"
}
],
"orgId": "string"
}
]
}List of users that are found.
userSearchTerm query parameter must be specified
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user is not authorized to use the API
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user is forbidden to use the API
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
Organization with this identifier is not found.
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
The user has sent too many requests
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
An unexpected error has occurred while processing the request
"CspErrorResponse Object"cspErrorCode
message
errorCode
requestId
moduleCode
statusCode
curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/users/search?userSearchTerm=v