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

Get Service Roles

Description

Lists the assigned service roles of a user in an orgnization.

Request

Request

URL

URL


get
https://{api_host}/v1/users/{userId}/orgs/{orgId}/service-roles
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


string
userId Required

The userId or user account identifier.


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 array of ServiceRoles of type application/json
{
    "ServiceRoles": {
        "resourceTypes": [
            "...",
            "..."
        ],
        "resources": [
            {
                "id": "...",
                "name": "..."
            },
            {
                "id": "...",
                "name": "..."
            }
        ],
        "roles": [
            {
                "associatedResources": [
                    "...",
                    "..."
                ],
                "defaultRole": true,
                "displayName": "...",
                "enabled": true,
                "hidden": true,
                "memberType": "DIRECT",
                "mspDefaultRole": true,
                "mspDefaultRoleOfProviderAtTenant": true,
                "name": "...",
                "resource": "...",
                "roleId": "...",
                "status": "..."
            },
            {
                "associatedResources": [
                    "...",
                    "..."
                ],
                "defaultRole": true,
                "displayName": "...",
                "enabled": true,
                "hidden": true,
                "memberType": "GROUP",
                "mspDefaultRole": true,
                "mspDefaultRoleOfProviderAtTenant": true,
                "name": "...",
                "resource": "...",
                "roleId": "...",
                "status": "..."
            }
        ],
        "serviceDisplayName": "...",
        "serviceId": "..."
    },
    "resourceTypes": [
        "...",
        "..."
    ],
    "resources": [
        {
            "id": "...",
            "name": "..."
        },
        {
            "id": "...",
            "name": "..."
        }
    ],
    "roles": [
        {
            "associatedResources": [
                "...",
                "..."
            ],
            "defaultRole": true,
            "displayName": "...",
            "enabled": true,
            "hidden": true,
            "memberType": "DIRECT",
            "mspDefaultRole": true,
            "mspDefaultRoleOfProviderAtTenant": true,
            "name": "...",
            "resource": "...",
            "roleId": "...",
            "status": "..."
        },
        {
            "associatedResources": [
                "...",
                "..."
            ],
            "defaultRole": true,
            "displayName": "...",
            "enabled": true,
            "hidden": true,
            "memberType": "GROUP",
            "mspDefaultRole": true,
            "mspDefaultRoleOfProviderAtTenant": true,
            "name": "...",
            "resource": "...",
            "roleId": "...",
            "status": "..."
        }
    ],
    "serviceDisplayName": "...",
    "serviceId": "..."
}
array of string
resourceTypes Optional

The list of resource types.


array of Resource
resources Optional

The list of resources.


array of ServiceRole
roles Optional

The list of role objects.


string
serviceDisplayName Optional

The display name of the service.


string
serviceId Optional

The service definition id (without “external” prefix.)

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/users/{userId}/orgs/{orgId}/service-roles


Feedback

Was this page helpful?