Skip to content
XOS Developers

Delete an OAuth grant

Settings module

DELETE/oauth-grants/{id}oauthGrants.delete

A user's consent grant to an OAuth app. Revocable. Soft-deletes the OAuth grant: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability me.account.write.
  • OAuth scopes: me.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

oauthGrants.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the oauth grant.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/oauth-grants/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.oauthGrants.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.oauth_grants.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos oauth-grants delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f