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

Update Organization And Service Roles Of OAuth Client

Description

Updates the organization and service roles of an OAuth client in a specified organization.

Request

Request

URL

URL


patch
https://console.navigator.vmware.com/cphub/api/auth/v2/clients/{clientId}/orgs/{orgId}/roles
Copy

Path Parameters

Path Parameters

string
clientId Required

The unique identifier of the client.


string
orgId Required

Unique identifier (GUID) of the organization.


Query Parameters

Query Parameters

string
context Optional

PROVIDER, TENANT


Request Body

Request Body

UpdateRolesRequest of mimetype application/json Optional

Request body to update the organization and service roles of an OAuth client

{
	"orgRoleBindingOrgs": {
		"orgsToAdd": [
			"string"
		],
		"orgsToRemove": [
			"string"
		]
	},
	"organizationRoles": {
		"rolesToAdd": [
			{
				"name": "string"
			}
		],
		"rolesToRemove": [
			{
				"name": "string"
			}
		]
	},
	"serviceRoles": [
		{
			"rolesToAdd": [
				{
					"name": "string"
				}
			],
			"rolesToRemove": [
				{
					"name": "string"
				}
			],
			"serviceDefinitionId": "string"
		}
	]
}
orgRoleBindingOrgs Optional

Defines the properties to update Organization bindings.


organizationRoles Optional

The roles to be updated.


serviceRoles Optional

The list of service roles to be updated.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

200 OK

OK

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


404

Not Found - The requested resource does not exist


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 '{"orgRoleBindingOrgs":{"orgsToAdd":["string"],"orgsToRemove":["string"]},"organizationRoles":{"rolesToAdd":[{"name":"string"}],"rolesToRemove":[{"name":"string"}]},"serviceRoles":[{"rolesToAdd":[{"name":"string"}],"rolesToRemove":[{"name":"string"}],"serviceDefinitionId":"string"}]}' https://console.navigator.vmware.com/cphub/api/auth/v2/clients/{clientId}/orgs/{orgId}/roles


Feedback

Was this page helpful?