GET
/api/apps/{app_id}/check-authorizationAuthenticatedCheck whether the caller authorized an app
Reports whether the signed-in user has already authorized the client application to receive tokens on their behalf (authorized), and — given the authorization request's scope and resource — whether the consent screen has to be shown before an authorization code is handed to the app (consent_required): the app is not authorized yet, or the request asks for API scopes the user has not granted it (pending_api_scopes). The auth server's own app is always reported as authorized and never needs consent.
operationId
get_api_apps_app_id_check_authorizationClient applicationsAuthentication & permissionsAuthenticated
Any authenticated user
- Accepted credentials
- Auth server session (refresh token cookie)
cookie "refresh_token_<auth_server_app_id>" - Access token (cookie)
cookie "access_token_<auth_server_app_id>" - Access token (Bearer)
Authorization: Bearer <JWT>
- Auth server session (refresh token cookie)
- Who may call
- Any authenticated user
Path parameters
| Name | Type | Description |
|---|---|---|
| app_id* | string | Client application id |
Query parameters
| Name | Type | Description |
|---|---|---|
| scope | string | The authorization request's requested scopes (space delimited). |
| resource | string | The authorization request's RFC 8707 resource indicator, whose API scopes |
Responses
application/json
AppAuthorizationStatusResponse
authorized: whether the caller authorized the app at all. With the authorization request's scope / resource as query parameters, also what the consent screen has to ask for: consent_required (the app is not authorized yet, or the request asks for API scopes the caller has not granted it), the requested OIDC scopes, and the requested API scopes of the resource's API server split into already granted and pending ones.| Property | Type | Description |
|---|---|---|
| success* | true | |
| authorized* | boolean | |
| consent_required* | boolean | |
| requested_oidc_scopes* | string[] | |
| api_server* | object | null | null | |
| api_server_id* | string | minLength: 2maxLength: 64pattern: ^[a-z0-9_-]*$ |
| api_server_name* | string | |
| granted_api_scopes* | object[] | |
| api_server_scope_id* | string (uuid) | |
| scope* | string | |
| description* | string | |
| pending_api_scopes* | object[] | |
| api_server_scope_id* | string (uuid) | |
| scope* | string | |
| description* | string |
JSONExample
"success"true
"authorized"true
"consent_required"true
"requested_oidc_scopes"
"string"
"api_server"
"api_server_id""string"
"api_server_name""string"
"granted_api_scopes"
"api_server_scope_id""123e4567-e89b-12d3-a456-426614174000"
"scope""string"
"description""string"
"pending_api_scopes"
"api_server_scope_id""123e4567-e89b-12d3-a456-426614174000"
"scope""string"
"description""string"
Example request
bashcurl
curl -X GET 'https://auth.schemavaults.com/api/apps/<app_id>/check-authorization' \
-b 'refresh_token_<auth_server_app_id>=<value>'