[{"label":"Latest (v1.0)","version":"latest"}]
csp
Get Organization Roles By Organization ID
DescriptionGet list of organization roles. Expand parameter is supported. If it is true, organization roles will be returned in the response.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Member | ✔️ | ✔️ |
| Organization Admin | ✔️ | ✔️ |
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/orgs/{orgId}/roles
Path Parameters
Path Parameters
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
simple Explode:false
Query Parameters
Query Parameters
boolean
expand
Optional
Indicates if response should be expanded, value is ignored - only the existence of parameter is checked.
Parameter Serialization Style:
form Explode:true
string
name
Optional
Role name (or comma separated list of role names
Parameter Serialization Style:
form Explode:true
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
OrganizationRolesResponse
of type application/json
{
"orgRolesData": [
{
"createdBy": "string",
"createdDate": "string",
"displayName": "string",
"expiresAt": 0,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"name": "string",
"organizationLink": "string",
"resource": "string",
"visible": false
}
],
"refLinks": [
"string"
]
}
array of
string
refLinks
Optional
The list of links of references.
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 with this identifier is not found.
CspErrorResponse
429
The user has sent too many requests
CspErrorResponse
500
An unexpected error has occurred while processing the request
Code Samples
cURL Command
curl https://{api_host}/csp/gateway/am/api/orgs/{orgId}/roles
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
[{"label":"Latest (v1.0)","version":"latest"}]
csp
On This Page
Organization Operations
post
post
delete
