Get Organization Users By Organization Id Using GET

Get Organization Users By Organization Id Using GET

Get response encapsulating organization users.
Fetched page is according to the page start and page limit passed as optional parameters.
Optionally provide "serviceDefinitionId" to filter users having access to a service. Organization Members are permitted to see only basic user information. Organization owners, read-only administrators and organization admins will see also organization and service roles of the users and userProfile if expandProfile is passed.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
Organization Member ✔️ ✔️
Organization Admin ✔️ ✔️
Organization Owner ✔️ ✔️
Request
URI
GET
https://{api_host}/csp/gateway/am/api/v2/orgs/{orgId}/users
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Query Parameters
string
serviceDefinitionId
Optional

Service definition id used to filter users having access to the service.

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

Maximum number of users to return in response

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.

string
excludeRoles
Optional

Indicates if the response should exclude the user roles; the value is ignored, only the existence of parameter is checked.

string
includeGroupIdsInRoles
Optional

Indicates if the inherited roles in the response should indicate group information; the value is ignored, only the existence of parameter is checked.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns PagedErrorAwareResponseExpandedTypedUserDto of type(s) application/json 
{
    "totalResults": 2000,
    "results": [
        {
            "user": {
                "firstName": "string",
                "lastName": "string",
                "userProfile": {
                    "locale": "string",
                    "language": "string",
                    "alternativeEmail": "string"
                },
                "userId": "string",
                "email": "string",
                "acct": "string",
                "domain": "string",
                "accessible": false,
                "username": "string",
                "idpId": "string"
            },
            "organizationRoles": [
                {
                    "displayName": "string",
                    "name": "string",
                    "resource": "string",
                    "createdBy": "string",
                    "lastUpdatedDate": "string",
                    "expiresAt": 3609941597,
                    "groups": [
                        {
                            "domain": "string",
                            "displayName": "string",
                            "id": "string",
                            "ownerOrgId": "string",
                            "sharedOrgIds": [
                                "string"
                            ],
                            "groupType": "string",
                            "usersCount": 0,
                            "description": "string"
                        }
                    ],
                    "createdDate": "string",
                    "membershipType": "string",
                    "groupIds": [
                        "string"
                    ],
                    "lastUpdatedBy": "string"
                }
            ],
            "serviceRoles": [
                {
                    "serviceRoleNames": [
                        "string"
                    ],
                    "serviceDefinitionId": "string",
                    "serviceRoles": [
                        {
                            "name": "string",
                            "resource": "string",
                            "createdBy": "string",
                            "lastUpdatedBy": "string",
                            "expiresAt": 3609941597,
                            "groups": [
                                {
                                    "domain": "string",
                                    "displayName": "string",
                                    "id": "string",
                                    "ownerOrgId": "string",
                                    "sharedOrgIds": [
                                        "string"
                                    ],
                                    "groupType": "string",
                                    "usersCount": 0,
                                    "description": "string"
                                }
                            ],
                            "createdDate": "string",
                            "membershipType": "string",
                            "groupIds": [
                                "string"
                            ],
                            "lastUpdatedDate": "string"
                        }
                    ]
                }
            ],
            "customRoles": [
                {
                    "name": "string",
                    "resource": "string",
                    "createdBy": "string",
                    "lastUpdatedBy": "string",
                    "expiresAt": 3609941597,
                    "groups": [
                        {
                            "domain": "string",
                            "displayName": "string",
                            "id": "string",
                            "ownerOrgId": "string",
                            "sharedOrgIds": [
                                "string"
                            ],
                            "groupType": "string",
                            "usersCount": 0,
                            "description": "string"
                        }
                    ],
                    "createdDate": "string",
                    "membershipType": "string",
                    "groupIds": [
                        "string"
                    ],
                    "lastUpdatedDate": "string"
                }
            ],
            "orgId": "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 not found | Service 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/v2/orgs/{orgId}/users
On This Page
Organization Operations
GET
Get Sub Organizations By Organization Id Using GET
POST
Activate Organization Refresh Tokens Using POST
Deprecated
GET
Get Organization Roles By Organization Id Using GET
POST
Search Organization Users By Organization Id And Roles Search Term Using POST
GET
Get Users In Organization By Organization Id And User Search Term Using GET
Deprecated
DELETE
Revoke User Invitation By Organization Id And User Invitation Id Using DELETE
GET
Get User Invitation By Organization Id And User Invitation Id Using GET
POST
Deactivate Organization Refresh Tokens With Api Token Path Using POST
POST
Assign Roles To Clients On Organization Using POST
DELETE
Remove Clients From Organization By Organization Id Using DELETE
GET
Get Organization Clients By Organization Id Using GET
POST
Deactivate Organization Refresh Tokens Using POST
Deprecated
PATCH
Update Organization By Organization Id Using PATCH
GET
Get Organization By Id Using GET
DELETE
Remove Users From Organization By Organization Id Using DELETE
GET
Get Organization Users By Organization Id Using GET
POST
Activate Organization Refresh Tokens With Api Token Path Using POST
POST
Invite Users Using POST
GET
Get Organization Invitations By Organization Id Using GET
POST
Link Org To Idp Using POST
DELETE
Delete Organization Idp Registration Using DELETE
GET
Get Org Linked Idp Details Using GET
GET
Get Groups In Organizations By Organization Id And Group Search Term Using GET