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

Get Allowed OAuth Role Based Scopes Of Organization

Description

Retrieves details about the allowed OAuth role-based scopes of a specified organization.

Request

Request

URL

URL


get
https://{api_host}/v2/orgs/{orgId}/oauth-apps/scopes
Copy

Path Parameters

Path Parameters

string
orgId Required

Unique identifier (GUID) of the organization.


Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns array of AllowedScopeDescriptor of type application/json
{
	"enabled": false,
	"incompatibleWith": [
		"string"
	],
	"name": "string",
	"serviceScopeType": "ALL_SERVICES"
}
boolean
enabled Optional

Indicates if enabled or not.


array of string
incompatibleWith Optional

The list of incompatible with related to allowed scopes.


string
name Optional

The name of the allowed scope.


serviceScopeType Optional

The value of the Service scope type.

Possible values are: ALL_SERVICESNO_SERVICES

Errors

Errors

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/orgs/{orgId}/oauth-apps/scopes


Feedback

Was this page helpful?