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

Get Logged In User Roles On Organization By Organization ID

Description

Get principal user roles within the specified organization.

Access Policy

Role User Accounts Service Accounts (Client Credentials Applications)
All Roles ✔️

Request

Request

URL

URL


get
https://{api_host}/csp/gateway/am/api/loggedin/user/orgs/{orgId}/roles
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.

Parameter Serialization Style: simple Explode:false

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response 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

Errors

401

The user is not authorized to use the API


403

The user is forbidden to use the API


404

No user with given token exists | Organization not found


429

The user has sent too many requests


500

An unexpected error has occurred while processing the request

Code Samples

Code Samples

PowerCLI Client SDK Example

Invoke-GetLoggedInUserRolesOnOrgUsingGET -OrgId "MyOrgId"

cURL Command

curl https://{api_host}/csp/gateway/am/api/loggedin/user/orgs/{orgId}/roles
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?