COconductorone
Cross-App Access

Create

Changed on

Declare a scope under a resource server. The scope value is the literal OAuth scope string and is immutable after creation.

post/api/v1/apps/{app_id}/xaa/scopes

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/apps/{app_id}/xaa/scopes
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Path parameters

app_idstring required

The application that owns the resource server.

Request body

classification'XAA_SCOPE_CLASSIFICATION_UNSPECIFIED' | 'XAA_SCOPE_CLASSIFICATION_READ' | 'XAA_SCOPE_CLASSIFICATION_WRITE' | 'XAA_SCOPE_CLASSIFICATION_DESTRUCTIVE' | 'XAA_SCOPE_CLASSIFICATION_SENSITIVE' | 'XAA_SCOPE_CLASSIFICATION_DANGEROUS'

Risk classification.

descriptionstring

Description of what the scope grants.

displayNamestring

Display name for the scope.

scopeValuestring

The literal OAuth scope string. Immutable after creation.

state'XAA_SCOPE_STATE_UNSPECIFIED' | 'XAA_SCOPE_STATE_PENDING_REVIEW' | 'XAA_SCOPE_STATE_ENABLED' | 'XAA_SCOPE_STATE_DISABLED' | 'XAA_SCOPE_STATE_REMOVED'

Initial state. UNSPECIFIED defaults to PENDING_REVIEW.

xaaResourceServerIdstring

The resource server this scope belongs to.

Response

XAAScopeServiceCreateResponse returns the created scope.

Changes