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

Get users in group within organization. Optionally filtered by given firstName, lastName or email with 'contains' match. Optionally filter the users by using onlyDirectUsers with true to return only direct users and not return the users from nested groups.

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}/users

COPY

Path Parameters

string

orgId

Required

Unique identifier (GUID) of the organization.

string

groupId

Required

Unique identifier of the group.

Query Parameters

integer

pageStart

Optional

Specifies the index that the set of results will begin with

integer

pageLimit

Optional

Specifies the maximum results per page for every call.

string

firstName

Optional

The first name of the user.

string

lastName

Optional

The last name of the user.

string

Optional

The email address of the user.

boolean

onlyDirectUsers

Optional

Indicates if the response should be filter by direct users. If true, only direct users will be returned.

string

expandProfile

Optional

Indicates if the response should be expanded with the user profile; the value is ignored, only the existence of parameter is checked.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Returns PagedResponseBaseUserWithProfileDto of type(s) application/json

{
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15",
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "results": [
        {
            "accessible": false,
            "acct": "string",
            "domain": "string",
            "email": "string",
            "firstName": "string",
            "idpId": "string",
            "lastName": "string",
            "userId": "string",
            "userProfile": {
                "alternativeEmail": "string",
                "language": "string",
                "locale": "string"
            },
            "username": "string"
        }
    ],
    "totalResults": 2000
}

string

nextLink

Optional

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

string

prevLink

Optional

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

array of BaseUserWithProfileDto

results

Optional

Partial list of returned results.

integer As int32 As int32

totalResults

Optional

Total number of results if available.

400

Group not part of the organization

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

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