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

Get OAuth Client

Description

Retrieves details about a specified OAuth client which has been assigned roles, in a given organization.

Request

Request

URL

URL


get
https://{api_host}/v2/orgs/{orgId}/clients/{clientId}
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


string
clientId Required

Unique identifier of the client.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns CpnOrgOauthAppClient of type application/json
{
	"description": "string",
	"displayName": "string",
	"id": "string",
	"organizationRoles": [
		{
			"name": "string"
		}
	],
	"serviceRoles": [
		{
			"serviceDefinitionId": "string",
			"serviceRoles": [
				{
					"name": "string"
				}
			]
		}
	],
	"sourceOrg": {
		"displayName": "string",
		"orgId": "string",
		"shortId": "string"
	}
}
string
description Optional

The description of the OAuth Application client.


string
displayName Optional

The display name of the OAuth Application client.


string
id Optional

The unique identifier of the OAuth Application client.


organizationRoles Optional

List of organization role objects.


serviceRoles Optional

List of service role objects.


sourceOrg Optional

The source organization of the OAuth Application.

Errors

Errors

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 https://{api_host}/v2/orgs/{orgId}/clients/{clientId}


Feedback

Was this page helpful?