Get Organization Groups By Organization Id Using GET

Get groups of a specific 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

COPY

Path Parameters

string

orgId

Required

Unique identifier (GUID) of the organization.

Query Parameters

integer

pageStart

Optional

Constraints: minimum: 1 default: 1

Specifies the index that the set of results will begin with

integer

pageLimit

Optional

Constraints: minimum: 1 maximum: 200 default: 200

Specifies the maximum results per page for every call.

string

groupId

Optional

Unique identifier of the group.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns PagedErrorAwareResponseExpandedGroupDto of type(s) application/json

{
    "totalResults": 2000,
    "results": [
        {
            "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"
        }
    ],
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15",
    "errors": [
        {
            "message": "string"
        }
    ]
}

integer As int32 As int32

totalResults

Optional

Total number of results if available.

array of object

results

Optional

Partial list of returned results.

string

prevLink

Optional

Relative path to previous page if exists. Not returned for POST requests.

string

nextLink

Optional

Relative path to next page if exists. Not returned for POST requests.

array of object

errors

Optional

Any errors that occurred during the execution of an operation

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.

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

On This Page

Description

Request

Path Parameters

Query Parameters

Authentication

Response

200 Response Body

Errors

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