Search Groups Within Organization By Organization Id And Group Roles Using POST
Get all groups within organization that have certain role(s) and/or resource, including subgroups if they have a role assigned to their parent group (which affects them as well).
For all groups found by these search criteria the result contains all groups roles, no matter if they are part of the search criteria or not.
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.
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.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Member | ✔️ | ✔️ |
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Unique identifier (GUID) of the organization.
Indicates if the response should be filtered by search parameters from the request: resource, resourceStartsWith and roles names (default: false).
"SearchGroupsByRolesRequest Object"Defines the searching capability of the "resource" field value.
Maximum number to return in response. Default value is 200.
Defines the roles properties which are used for search.
Start index for querying. Default value is 1.
The string to be searched within group's display name.Max search length is 180 characters.
Resource to search for resource-scoped role assignments starting with given term. This field is deprecated. Consider using "resource" along with "searchType".
Resource to search for resource-scoped role assignments.
OK
{
"itemsPerPage": 25,
"totalResults": 2000,
"startIndex": 5,
"results": [
{
"groupType": "string",
"displayName": "string",
"id": "string",
"organizationRoles": [
{
"displayName": "string",
"name": "string",
"expiresAt": 3609941597,
"createdBy": "string",
"lastUpdatedDate": "string",
"resource": "string",
"membershipType": "string",
"createdDate": "string",
"lastUpdatedBy": "string"
}
],
"serviceRoles": [
{
"serviceRoleNames": [
"string"
],
"serviceDefinitionId": "string",
"serviceRoles": [
{
"createdBy": "string",
"lastUpdatedBy": "string",
"name": "string",
"lastUpdatedDate": "string",
"expiresAt": 3609941597,
"membershipType": "string",
"resource": "string",
"createdDate": "string"
}
]
}
],
"ownerOrgId": "string",
"domain": "string",
"sharedOrgIds": [
"string"
],
"customRoles": [
{
"createdBy": "string",
"lastUpdatedBy": "string",
"name": "string",
"lastUpdatedDate": "string",
"expiresAt": 3609941597,
"membershipType": "string",
"resource": "string",
"createdDate": "string"
}
],
"usersCount": 0,
"description": "string"
}
]
}Number of items per page.
Total number of results if available
Start index of the results.
Partial list of returned results.
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 request could not be processed due to a conflict
"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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/search