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

Get Users In Group Within Organization By Organization ID And Group ID

Description

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 Owner ✔️ ✔️

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

string
groupId Required

Unique identifier of the group.

Parameter Serialization Style: simple Explode:false

Query Parameters

Query Parameters

string
email Optional

The email address of the user.

Parameter Serialization Style: form Explode:true

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
firstName Optional

The first name of the user.

Parameter Serialization Style: form Explode:true

string
lastName Optional

The last name of the user.

Parameter Serialization Style: form Explode:true

boolean
onlyDirectUsers Optional

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

Parameter Serialization Style: form Explode:true

integer
pageLimit Optional

Specifies the maximum results per page for every call.

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

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns PagedResponseBaseUserWithProfileDto 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

400

Group not part of the organization


401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

Organization with this identifier is not found. | Group with this identifier is not found.


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

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

Vendor Extensions

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


Feedback

Was this page helpful?