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

Get Organization Bindings Of Client Organization And Role ID

Description

Retreives details about the organization bindings of a specified client, organization and role ID.

Request

Request

URL

URL


get
https://{api_host}/v2/clients/{clientId}/orgs/{orgId}/org-roles/{roleId}/org-bindings
Copy

Path Parameters

Path Parameters

string
clientId Required

Unique identifier of the client.


string
orgId Required

Unique identifier (GUID) of the organization.


string
roleId Required

Unique identifier of the role.


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
[
	{
		"createTimestamp": 12345,
		"inactive": true,
		"natures": [
			"ALL_NATURE"
		],
		"orgId": "string",
		"orgType": "OPERATOR",
		"parentOrgId": "string",
		"realm": "CPHUB",
		"updateTimestamp": 12345
	}
]
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

400

Bad Request - The request is either incomplete or incorrect - The request is either incomplete or incorrect


401

Unauthorized - The user is not authorized to use the API


403

Forbidden - User does not have permission for this operation


500

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

Code Samples

Code Samples

cURL Command

curl https://{api_host}/v2/clients/{clientId}/orgs/{orgId}/org-roles/{roleId}/org-bindings


Feedback

Was this page helpful?