Skip to main content
POST
Search

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.

Body

application/json

XAAScopeServiceSearchRequest searches scopes with filters.

appIds
string[] | null

Optional filter by applications. Empty matches any application.

classificationFilter
enum<string>[] | null

Optional filter by classification. UNSPECIFIED means no filter.

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
pageSize
integer<int32>

Page size (max 100).

pageToken
string

Page token for pagination.

query
string

Optional text query matched against scope_value and display_name.

refs
Xaa Scope Ref · object[] | null

Optional: fetch a specific set of scopes by ref (used by websocket notify to re-fetch individual rows).

sourceFilter
enum<string>[] | null

Optional filter by source. UNSPECIFIED means no filter.

Available options:
XAA_SCOPE_SOURCE_UNSPECIFIED,
XAA_SCOPE_SOURCE_ADMIN_DECLARED,
XAA_SCOPE_SOURCE_DISCOVERED
stateFilter
enum<string>[] | null

Optional filter by state. UNSPECIFIED means no filter.

Available options:
XAA_SCOPE_STATE_UNSPECIFIED,
XAA_SCOPE_STATE_PENDING_REVIEW,
XAA_SCOPE_STATE_ENABLED,
XAA_SCOPE_STATE_DISABLED,
XAA_SCOPE_STATE_REMOVED
xaaResourceServerIds
string[] | null

Optional filter by resource servers. Empty matches any resource server.

Response

200 - application/json

XAAScopeServiceSearchResponse returns matching scopes.

XAAScopeServiceSearchResponse returns matching scopes.

list
Xaa Scope · object[] | null

Matching scopes.

nextPageToken
string

Token for the next page.