Skip to content
Start here

OAuth Scopes

List OAuth Scopes
client.iam.oauthScopes.list(RequestOptionsoptions?): SinglePage<OAuthScopeListResponse { id, name, category, scopes } >
GET/oauth/scopes
ModelsExpand Collapse
OAuthScopeListResponse { id, name, category, scopes }

An available OAuth scope that can be assigned to an OAuth client.

id: string

The scope label to use in the scopes array when creating or updating an OAuth client.

name: string

Human-readable name of the OAuth scope.

category?: string

Category for grouping scopes in the UI.

scopes?: Array<string>

The underlying resource scopes (Bach scopes) that define which resources this OAuth scope can act upon.