GET
/api/apis/{api_server_id}/connect_app/{client_app_id}AuthenticatedCheck whether an app is connected to an API server
Reports whether the client application is connected to the API server, i.e. may be issued access tokens with the API server as audience.
operationId
get_api_apis_api_server_id_connect_app_client_app_idAPI serversAuthentication & 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
- Notes
- The caller must own the client application (organization owner, owning user, or platform administrator) and, unless the API server is a public hardcoded one, must own the API server too.
Path parameters
| Name | Type | Description |
|---|---|---|
| api_server_id* | string | API server id |
| client_app_id* | string | Client application id |
Responses
application/json
AppToApiServerConnectionResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| is_allowed* | boolean | Whether the client application is connected to (may request tokens for) the API server |
JSONExample
"success"true
"is_allowed"true
Example request
bashcurl
curl -X GET 'https://auth.schemavaults.com/api/apis/<api_server_id>/connect_app/<client_app_id>' \
-b 'refresh_token_<auth_server_app_id>=<value>'