[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Get Available Org Roles

Description

Lists all organization roles available to users in your organization.

Request

Request

URL

URL


get
https://{api_host}/v1/orgs/{orgId}/org-roles
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


Query Parameters

Query Parameters

string
context Optional

context can be OPERATOR, PROVIDER or TENANT


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns OrgRoles of type application/json
{
    "OrgRoles": {
        "orgRoles": [
            {
                "displayName": "...",
                "id": "...",
                "memberType": "DIRECT",
                "name": "...",
                "orgId": "..."
            },
            {
                "displayName": "...",
                "id": "...",
                "memberType": "DIRECT",
                "name": "...",
                "orgId": "..."
            }
        ]
    },
    "orgRoles": [
        {
            "displayName": "...",
            "id": "...",
            "memberType": "DIRECT",
            "name": "...",
            "orgId": "..."
        },
        {
            "displayName": "...",
            "id": "...",
            "memberType": "DIRECT",
            "name": "...",
            "orgId": "..."
        }
    ]
}
array of Role
orgRoles Optional

The list of organization role objects.

Errors

Errors

401

Unauthorized - The user is not authorized to use the API


500

Internal Server Error - An unexpected error has occurred while processing the request

Code Samples

Code Samples

cURL Command

curl https://{api_host}/v1/orgs/{orgId}/org-roles


Feedback

Was this page helpful?