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

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.
Responses
200

OK

Returns ExpandedGroupDto of type(s) application/json 
{
    "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"
}
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
displayName
Optional

The display name of the group.

string
id
Optional

Unique identifier of the group.

array of object
organizationRoles
Optional

The organization roles of the group.

array of object
serviceRoles
Optional

The service roles of the group.

string
ownerOrgId
Optional

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

string
domain
Optional

The domain name of the group.

array of string
sharedOrgIds
Optional

Unique identifiers (GUID) of the shared organizations.

array of object
customRoles
Optional

The custom roles of the group.

integer As int32 As int32
usersCount
Optional

Number of users in the group.

string
description
Optional

Description of the custom group. For enterprise groups the value will be null.


401

The user is not authorized to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


403

The user is forbidden to use the API

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

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 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


429

The user has sent too many requests

Returns CspErrorResponse of type(s) application/json 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

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 
"CspErrorResponse Object"
string
cspErrorCode
Optional

cspErrorCode

string
message
Optional

message

string
errorCode
Optional

errorCode

string
requestId
Optional

requestId

integer As int32 As int32
moduleCode
Optional

moduleCode

integer As int32 As int32
statusCode
Optional

statusCode


Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/groups/{groupId}
On This Page
Organization Groups Operations
POST
Add Users To Custom Group In Organization By Organization Id And Group Id Using POST
DELETE
Remove Users From Custom Group In Organization By Organization Id And Group Id And User Ids Using DELETE
GET
Get Users In Group Within Organization By Organization Id And Group Id Using GET
PATCH
Update Group Details In Organization By Organization Id And Group Id Using PATCH
GET
Get Group In Organization By Organization Id And Group Id Using GET
PATCH
Update Group Roles On Organization By Organization Id And Group Id Using PATCH
GET
Get Group Roles On Organization By Organization Id And Group Id Using GET
GET
Get Nested Enterprise Groups From Custom Group By Organization Id And Group Id Using GET
POST
Create Custom Group In Organization By Organization Id Using POST
DELETE
Remove Groups From Organization By Organization Id And Groups Id Using DELETE
GET
Get Organization Groups By Organization Id Using GET
POST
Search Groups Within Organization By Organization Id And Group Roles Using POST