DELETE
/api/me/connected-apps/{app_id}/scopes/{api_server_scope_id}AuthenticatedWithdraw an API scope from a connected app
Withdraws the caller's consent to one API scope for a client application. The app's unexpired access tokens for that scope's API server are revoked (resource servers that introspect tokens or check revocation stop accepting them; ones that only verify signatures accept them until they expire), and its refresh tokens stop carrying the scope from their next rotation. The app stays authorized; signing in again with the scope asks for consent again. Idempotent.
operationId
delete_api_me_connected_apps_app_id_scopes_api_server_scope_idAccountAuthentication & 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 |
| api_server_scope_id* | string (uuid) | Id of the API scope to withdraw |
Responses
application/json
ApiScopeConsentRevocationResponse
| Property | Type | Description |
|---|---|---|
| success* | true | |
| message* | string | |
| was_granted* | boolean | Whether the caller had granted the scope; false means there was nothing to withdraw |
| revoked_token_count* | integer | How many of the app's unexpired access tokens for the scope's API server were revoked minimum: 0 |
JSONExample
"success"true
"message""string"
"was_granted"true
"revoked_token_count"1
Example request
bashcurl
curl -X DELETE 'https://auth.schemavaults.com/api/me/connected-apps/<app_id>/scopes/<api_server_scope_id>' \
-b 'refresh_token_<auth_server_app_id>=<value>'