Get User Group
Last modified: 11 March 2025
Request
GET <REST API URL>/usergroups/{user group id}?fields=stringParameter | Description |
|---|---|
fields | Optional. Returns only the specified subset of the fields for each UserGroup. Use Fields Syntax to define the subset. |
Response
Response Code | Meaning |
|---|---|
200 OK | Successful request. |
400 Bad Request | At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response. |
403 Forbidden | The requester has no access to the requested resource. |
404 Not Found | The requested resource was not found. |
500 Internal Server Error | Failed to process request because of the server error. For details, check the error message in the response. |
Response body
{
"description": string,
"iconUrl": string,
"autoJoin": boolean,
"autoJoinDomain": string,
"requiredTwoFactorAuthentication": boolean,
"parentsRequireTwoFactorAuthentication": boolean,
"users": [user, ...],
"ownUsers": [user, ...],
"userCount": int,
"parent": userGroup,
"subgroups": [userGroup, ...],
"teams": [projectTeam, ...],
"organizations": [organization, ...],
"project": project,
"allUsers": boolean,
"registeredUsers": boolean,
"implicit": boolean,
"queriedSingleton": boolean,
"removable": boolean,
"immutable": boolean,
"importedFromAuthModule": externalauthmodule,
"mappedInAuthModule": externalauthmodule,
"idpGroupId": string,
"idpGroupName": string,
"idpStatus": userGroupIdpStatus,
"idpGroupNameOverridden": boolean,
"id": string /* from authorityHolder */,
"aliases": [alias, ...] /* from authorityHolder */,
"name": string /* from authorityHolder */,
"projectRoles": [projectRole, ...] /* from authorityHolder */,
"transitiveProjectRoles": [projectRole, ...] /* from authorityHolder */,
"sourcedProjectRoles": [sourcedProjectRole, ...] /* from authorityHolder */,
"organizationRoles": [organizationRole, ...] /* from authorityHolder */,
"transitiveOrganizationRoles": [organizationRole, ...] /* from authorityHolder */,
"sourcedOrganizationRoles": [sourcedOrganizationRole, ...] /* from authorityHolder */
}