Get Group In Organization By Organization ID And Group ID
Get details of a group within organization.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:simple Explode:false
string
groupId
Required
Unique identifier of the group.
Parameter Serialization Style:simple Explode:false
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
ExpandedGroupDto of type application/json
{
"customRoles": [
{
"expiresAt": 3609941597,
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"description": "string",
"displayName": "string",
"domain": "string",
"groupType": "USER_GROUP",
"id": "string",
"organizationRoles": [
{
"displayName": "string",
"expiresAt": 3609941597,
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
],
"ownerOrgId": "string",
"serviceRoles": [
{
"serviceDefinitionId": "string",
"serviceRoleNames": [
"string"
],
"serviceRoles": [
{
"expiresAt": 3609941597,
"membershipType": "DIRECT",
"name": "string",
"resource": "string"
}
]
}
],
"sharedOrgIds": [
"string"
],
"usersCount": 0
}
string
description
Optional
Description of the custom group. For enterprise groups the value will be null.
string
displayName
Optional
The display name of the group.
string
domain
Optional
The domain name of the group.
string
groupType
Optional
USER_GROUP is an organization specific custom group, AD_GROUP is a federated domain group, SHARED_GROUP is group owned by another organization and shared with current one.
Possible values are: USER_GROUP , AD_GROUP , SHARED_GROUP
string
id
Optional
Unique identifier of the group.
string
ownerOrgId
Optional
Unique identifier (GUID) of the organization that is the owner of the current group.
array of
string
sharedOrgIds
Optional
Unique identifiers (GUID) of the shared organizations.
integer
usersCount
Optional
Number of users in the group.
Errors
404
Organization with this identifier is not found. | Group with this identifier is not found.
Code Samples
Code Samples
cURL Command
curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2
