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

Get Org Bindings For Role

Description

Retrieves the organization bindings of a user of a particular role within an organization.

Request

Request

URL

URL


get
https://{api_host}/v1/users/{userId}/orgs/{orgId}/org-roles/{roleId}/org-bindings
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


string
roleId Required

Unique identifier of the role.


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 OrgForAuth of type application/json
{
	"inactive": false,
	"natures": "ALL_NATURE",
	"orgId": "string",
	"orgType": "OPERATOR",
	"parentOrgId": "string",
	"realm": "CPHUB",
	"roleVersion": "string"
}
boolean
inactive Optional

Indicates if organization is inactive


array of OrgNature Enum
natures Optional

The nature of the Organization.

Possible values are: ALL_NATUREMSPPARTNEROPS_STOPDISTRIBUTOR


string
orgId Optional

The unique identifier of the organization


orgType Optional

The type of the organization.

Possible values are: OPERATORPROVIDERTENANT


string
parentOrgId Optional

The parent organization


realm Optional

The realm of the organization.

Possible values are: CPHUBCPATH


string
roleVersion Optional

The role version of the organization

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}/org-roles/{roleId}/org-bindings


Feedback

Was this page helpful?