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

Update Org Bindings For Role

Description

Updates the organization role bindings of a particular user in an organization.

Request

Request

URL

URL


patch
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


Request Body

Request Body

OrgItems of mimetype application/json Optional
{
    "orgsToAdd": [
        "...",
        "..."
    ],
    "orgsToRemove": [
        "...",
        "..."
    ]
}
array of string
orgsToAdd Optional

The organizations to add.


array of string
orgsToRemove Optional

The organizations to remove.

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

400

Bad Request - The request is either incomplete or incorrect


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 -X PATCH -H "Content-Type: application/json" -d '{"orgsToAdd":["...","..."],"orgsToRemove":["...","..."]}' https://{api_host}/v1/users/{userId}/orgs/{orgId}/org-roles/{roleId}/org-bindings
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: body


Feedback

Was this page helpful?