GET/api/apis/{api_server_id}/connect_app/{client_app_id}/scopesAuthenticated

Get a connected app's API scope allowances

Which of the API server's scopes the connected client application may be granted: on behalf of users (all of them unless restricted) and for its own service account on the client_credentials grant (none unless listed).

operationId get_api_apis_api_server_id_connect_app_client_app_id_scopesAPI servers

Authentication & permissionsAuthenticated

Any authenticated user

Accepted credentials
Who may call
Any authenticated user
Notes
Organization owners/admins (or the owning user) of the API server or of the app, or platform administrators.

Path parameters

NameTypeDescription
api_server_id*string

API server id

client_app_id*string

Client application id

Responses

application/json
AppApiScopePolicyResponse
PropertyTypeDescription
success*true
policy*AppApiScopePolicy

Which of the API server's scopes the connected app may be granted. restrict_user_scopes false (the default): users may grant the app every scope the API server defines (each user still consents per scope); true: only user_scopes. service_account_scopes: the scopes the app's own service account gets on the client_credentials grant, where no user consents (none by default).

restrict_user_scopes*boolean
user_scopes*string[]
service_account_scopes*string[]
JSONExample
"success"true
"policy"
"restrict_user_scopes"true
"user_scopes"
"string"
"service_account_scopes"
"string"

Example request

bashcurl
curl -X GET 'https://auth.schemavaults.com/api/apis/<api_server_id>/connect_app/<client_app_id>/scopes' \
  -b 'refresh_token_<auth_server_app_id>=<value>'

Other methods on this path