DELETE/api/apis/{api_server_id}/scopes/{api_server_scope_id}Authenticated

Delete an API scope

Deletes one of the API server's scopes. It is no longer granted, and refresh grants stop carrying it forward; access tokens already issued with it keep it until they expire.

operationId delete_api_apis_api_server_id_scopes_api_server_scope_idAPI servers

Authentication & 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>
Who may call: Any authenticated user
Notes: Organization owners/admins of the owning organization, the owning user of a user-owned API server, or platform administrators.

Path parameters

Name	Type	Description
api_server_id*	string	API server id
api_server_scope_id*	string (uuid)	Id of the API scope definition

Responses

application/json

SuccessMessageResponse

Property	Type	Description
success*	true
message*	string

JSONExample

"success"true

"message""string"

Example request

bashcurl

curl -X DELETE 'https://auth.schemavaults.com/api/apis/<api_server_id>/scopes/<api_server_scope_id>' \
  -b 'refresh_token_<auth_server_app_id>=<value>'

Other methods on this path

PATCHUpdate an API scope

Authentication & permissionsAuthenticated

Path parameters

Responses

200The scope was deleted

400The request failed validation (issues lists the offending fields) or was refused by the handler

401No valid session cookie, access token cookie or bearer access token was presented, or the token was revoked

403The account is disabled, or the credential is valid but not allowed to perform this operation

404No such API server, or it defines no scope with that id

500Failed to delete the scope

Example request

Other methods on this path