Get Group In Organization By Organization Id And Group Id Using GET

Get details of a group within organization.

Access Policy

Role	User Accounts	Service Accounts (Client Credentials Applications)
Organization Admin	✔️	✔️
Organization Owner	✔️	✔️

Request

URI

GET

https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}

COPY

Path Parameters

string

orgId

Required

Unique identifier (GUID) of the organization.

string

groupId

Required

Unique identifier of the group.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns ExpandedGroupDto of type(s) application/json

{
    "customRoles": [
        {
            "createdBy": "string",
            "createdDate": "string",
            "expiresAt": 3609941597,
            "lastUpdatedBy": "string",
            "lastUpdatedDate": "string",
            "membershipType": "string",
            "name": "string",
            "resource": "string"
        }
    ],
    "description": "string",
    "displayName": "string",
    "domain": "string",
    "groupType": "string",
    "id": "string",
    "organizationRoles": [
        {
            "createdBy": "string",
            "createdDate": "string",
            "displayName": "string",
            "expiresAt": 3609941597,
            "lastUpdatedBy": "string",
            "lastUpdatedDate": "string",
            "membershipType": "string",
            "name": "string",
            "resource": "string"
        }
    ],
    "ownerOrgId": "string",
    "serviceRoles": [
        {
            "serviceDefinitionId": "string",
            "serviceRoleNames": [
                "string"
            ],
            "serviceRoles": [
                {
                    "createdBy": "string",
                    "createdDate": "string",
                    "expiresAt": 3609941597,
                    "lastUpdatedBy": "string",
                    "lastUpdatedDate": "string",
                    "membershipType": "string",
                    "name": "string",
                    "resource": "string"
                }
            ]
        }
    ],
    "sharedOrgIds": [
        "string"
    ],
    "usersCount": 0
}

array of CustomRoleBindingDto

customRoles

Optional

The custom roles of the group.

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, DOMAIN_GROUP, SHARED_GROUP,

string

Optional

Unique identifier of the group.

array of OrganizationRoleBindingDto

organizationRoles

Optional

The organization roles of the group.

string

ownerOrgId

Optional

Unique identifier (GUID) of the organization that is the owner of the current group.

array of ServiceRolesWithIdDto

serviceRoles

Optional

The service roles of the group.

array of string

sharedOrgIds

Optional

Unique identifiers (GUID) of the shared organizations.

integer As int32 As int32

usersCount

Optional

Number of users in the group.

401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

404

Organization with this identifier is not found. | Group with this identifier is not found.

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message

integer As int32 As int32

moduleCode

Optional

moduleCode

string

requestId

Optional

requestId

integer As int32 As int32

statusCode

Optional

statusCode

500

An unexpected error has occurred while processing the request

Returns CspErrorResponse of type(s) application/json

{
    "cspErrorCode": "string",
    "errorCode": "string",
    "message": "string",
    "moduleCode": 0,
    "requestId": "string",
    "statusCode": 0
}

string

cspErrorCode

Optional

cspErrorCode

string

errorCode

Optional

errorCode

string

message

Optional

message