Search Organization Users By Organization ID And Roles Search Term
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
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/users/search
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
Search users by roles and/or resource.
(The request body parameter is missing description)
{
"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"
}
]
}
]
}
}
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
pageLimit
Optional
Maximum number to return in response. Default value is 200.
integer
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.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
PagedPostResponseExpandedTypedUserDto of type application/json
{
"itemsPerPage": 25,
"results": [
{
"customRoles": [
{
"expiresAt": 3609941597,
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"orgId": "string",
"organizationRoles": [
{
"displayName": "string",
"expiresAt": 3609941597,
"groupIds": [
"string"
],
"groups": [
{
"description": "string",
"displayName": "string",
"domain": "string",
"groupType": "USER_GROUP",
"id": "string",
"ownerOrgId": "string",
"sharedOrgIds": [
"string"
],
"usersCount": 0
}
],
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"serviceRoles": [
{
"serviceDefinitionId": "string",
"serviceRoleNames": [
"string"
],
"serviceRoles": [
{
"expiresAt": 3609941597,
"groupIds": [
"string"
],
"groups": [
{
"description": "string",
"displayName": "string",
"domain": "string",
"groupType": "USER_GROUP",
"id": "string",
"ownerOrgId": "string",
"sharedOrgIds": [
"string"
],
"usersCount": 0
}
],
"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
itemsPerPage
Optional
Number of items per page.
integer
startIndex
Optional
Start index of the results.
integer
totalResults
Optional
Total number of results if available
Errors
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"}]}]}}' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/users/search
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2
On This Page
Organization Operations
post
