Skip to main content
POST
Create

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

app_id
string
required

The application that owns the resource server.

Body

application/json

XAAScopeServiceCreateRequest declares a new scope.

classification
enum<string>

Risk classification.

Available options:
XAA_SCOPE_CLASSIFICATION_UNSPECIFIED,
XAA_SCOPE_CLASSIFICATION_READ,
XAA_SCOPE_CLASSIFICATION_WRITE,
XAA_SCOPE_CLASSIFICATION_DESTRUCTIVE,
XAA_SCOPE_CLASSIFICATION_SENSITIVE,
XAA_SCOPE_CLASSIFICATION_DANGEROUS
description
string

Description of what the scope grants.

displayName
string

Display name for the scope.

scopeValue
string

The literal OAuth scope string. Immutable after creation.

state
enum<string>

Initial state. UNSPECIFIED defaults to PENDING_REVIEW.

Available options:
XAA_SCOPE_STATE_UNSPECIFIED,
XAA_SCOPE_STATE_PENDING_REVIEW,
XAA_SCOPE_STATE_ENABLED,
XAA_SCOPE_STATE_DISABLED,
XAA_SCOPE_STATE_REMOVED
xaaResourceServerId
string

The resource server this scope belongs to.

Response

200 - application/json

XAAScopeServiceCreateResponse returns the created scope.

XAAScopeServiceCreateResponse returns the created scope.

scope
Xaa Scope · object | null

XAAScope is a single OAuth scope exposed by a resource server, elevated into a governable object bound to its own entitlement.