[{"label":"Latest (v1.0)","version":"latest"}]
csp
Get User Organization Roles By User ID And Organization ID
DescriptionGet user roles in an organization.
Access Policy
| Role | User Accounts | Service Accounts (Client Credentials Applications) |
|---|---|---|
| Organization Owner | ✔️ | ✔️ |
Request
URLURL
https://{api_host}/csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/roles
Path Parameters
Path Parameters
string
userId
Required
The userId or user account identifier.
Parameter Serialization Style:
simple Explode:false
string
orgId
Required
Unique identifier (GUID) of the organization.
Parameter Serialization Style:
simple Explode:false
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK
Returns
array of
RoleDto
of type application/json
{
"createdBy": "string",
"createdDate": "string",
"displayName": "string",
"expiresAt": 0,
"lastUpdatedBy": "string",
"lastUpdatedDate": "string",
"name": "string",
"organizationLink": "string",
"resource": "string",
"visible": false
}
string
name
Required
The name of the role.
string
organizationLink
Required
The link to the organization.
string
displayName
Optional
The organization role display name.
integer as int64
expiresAt
Optional
The timestamp the role expires at (measured in number of seconds since 1/1/1970 UTC).
string
lastUpdatedBy
Optional
Last Updated time of the role.
string
lastUpdatedDate
Optional
The timestamp the role was updated at (measured in number of seconds since 1/1/1970 UTC).
string
createdBy
Optional
The Creator of the role.
string
createdDate
Optional
The timestamp the role was created at (measured in number of seconds since 1/1/1970 UTC).
string
resource
Optional
The resource in which the role is scoped to. The resource will be embedded in the Access Token “perms” claim, as part of the role.
boolean
visible
Optional
Indicates if the role is visible.
Errors
Code Samples
Code Samples
PowerCLI Client SDK Example
Invoke-GetUserOrgRolesV2UsingGET -UserId "MyUserId" -OrgId "MyOrgId"
cURL Command
curl https://{api_host}/csp/gateway/am/api/v2/users/{userId}/orgs/{orgId}/roles
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-required-roles: org_owner
x-slo-tier: TIER2
[{"label":"Latest (v1.0)","version":"latest"}]
csp
