Search Groups Within Organization By Organization ID And Group Roles
DescriptionGet 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 | ✔️ | ✔️ |
Request
URLURL
Path Parameters
Path Parameters
Unique identifier (GUID) of the organization.
Query Parameters
Query Parameters
Indicates if the response should be filtered by search parameters from the request: resource, resourceStartsWith and roles names (default: false).
Request Body
{
"groupSearchTerm": "string",
"pageLimit": 0,
"pageStart": 0,
"resource": "string",
"resourceStartsWith": "string",
"rolesSearchTerm": {
"customRoles": [
{
"roleName": "string"
}
],
"orgRoles": [
{
"roleName": "string"
}
],
"serviceRoles": [
{
"serviceDefinitionId": "string",
"serviceRoles": [
{
"roleName": "string"
}
]
}
]
},
"searchType": "EXACT_MATCH"
}
The string to be searched within group’s display name.
Maximum number to return in response. Default value is 200.
Start index for querying. Default value is 1.
Resource to search for resource-scoped role assignments.
Resource to search for resource-scoped role assignments starting with given term. This field is deprecated. Consider using “resource” along with “searchType”.
Defines the searching capability of the “resource” field value.
Possible values are: EXACT_MATCH , CONTAINS , STARTS_WITH , ENDS_WITH
Authentication
Response
Response BodyResponse Body
200 OK
{
"itemsPerPage": 25,
"startIndex": 5,
"totalResults": 2000
}
Number of items per page.
Start index of the results.
Total number of results if available
Errors
The user is not authorized to use the API
The user is forbidden to use the API
Organization with this identifier is not found.
The request could not be processed due to a conflict
The user has sent too many requests
An unexpected error has occurred while processing the request
