POST
/api/apis/{api_server_id}/connect_app/{client_app_id}AuthenticatedConnect an app to an API server
Allows the client application to be issued access tokens for the API server. Responds 409 when the app is already connected (the client SDK maps it to AppAlreadyConnectedToApiServerError). No request body.
operationId
post_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
ResourceCreationResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| resource_id* | string | Identifier of the created / affected resource |
JSONExample
"success"true
"message""string"
"resource_id""string"
Example request
bashcurl
curl -X POST 'https://auth.schemavaults.com/api/apis/<api_server_id>/connect_app/<client_app_id>' \
-b 'refresh_token_<auth_server_app_id>=<value>'