[{"label":"Latest (v1.0)","version":"latest"}]
csp

Get Organization Users By Organization ID

Description

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 and read-only administrators 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

Request

URL

URL


get
https://{api_host}/csp/gateway/am/api/v2/orgs/{orgId}/users
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Query Parameters

Query Parameters

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.

Parameter Serialization Style: form Explode:true

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.

Parameter Serialization Style: form Explode:true

integer
pageLimit Optional

Maximum number of users to return in response

Parameter Serialization Style: form Explode:true

integer
pageStart Optional

Specifies the index that the set of results will begin with

Parameter Serialization Style: form Explode:true

string
serviceDefinitionId Optional

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

Parameter Serialization Style: form Explode:true

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PagedResponseExpandedTypedUserDto of type application/json
{
    "nextLink": "/csp/serviceName/ResourceName?pageStart=60&pageLimit=15",
    "prevLink": "/csp/serviceName/ResourceName?pageStart=30&pageLimit=15",
    "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.


results Optional

Partial list of returned results.


integer as int32
totalResults Optional

Total number of results if available.

Errors

Errors

CspErrorResponse
401

The user is not authorized to use the API


CspErrorResponse
403

The user is forbidden to use the API


CspErrorResponse
404

Organization not found | Service not found


CspErrorResponse
429

The user has sent too many requests


CspErrorResponse
500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/csp/gateway/am/api/v2/orgs/{orgId}/users
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner,org_admin,org_member
x-slo-tier: TIER2


Feedback

Was this page helpful?