Get Org Roles

Get Org Roles

Use this API instead:

  • /cloudapi/1.0.0/roles

Get list of organization roles.

Access Policy

Role Access
Platform operator ✔️
Organization Owner ✔️
Organization Member ❌
Service Account (Whitelisted Client) ✔️
Request
URI
GET
https://vra-interop-222-139.lvn.broadcom.net/csp/gateway/am/api/orgs/{orgId}/roles
COPY
Path Parameters
string
orgId
Required

Unique identifier (GUID) of the organization.

Query Parameters
string
name
Optional

Role name (or comma separated list of role names

boolean
expand
Optional

Indicates if response should be expanded, value is ignored - only existence of parameter is checked

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns OrganizationRolesResponse of type(s) */* 
{
    "refLinks": [
        "string"
    ],
    "orgRolesData": [
        {
            "refLink": "string",
            "name": "string",
            "displayName": "string",
            "organizationLink": "string",
            "visible": false,
            "orgId": "string",
            "expiresAt": 0,
            "resource": "string",
            "id": "string"
        }
    ]
}
array of string
refLinks
Optional

refLinks

array of object
orgRolesData
Optional

orgRolesData


401

The user is not authorized to use the API.

Returns OrganizationRolesResponse of type(s) */* 
"OrganizationRolesResponse Object"
array of string
refLinks
Optional

refLinks

array of object
orgRolesData
Optional

orgRolesData


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/csp/gateway/am/api/orgs/{orgId}/roles
Deprecated
On This Page
Organization Controller Operations
GET
Get By Id
Deprecated
PATCH
Patch Org
Deprecated
GET
Get Org Roles
Deprecated
PATCH
Patch Org Roles
Deprecated
GET
Get Org Sub Orgs
Deprecated
GET
Get Role By Org Id And Role Id
Deprecated
GET
Search Org Groups
Deprecated