oauth2

get

Lists the OAuth2 authorizations (grants) of the currently authenticated user.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Responses

200

Happy response.

application/json

Contains a list of OAuth2 user authorizations.

default

Error object.

application/json

get/api/v0/users/me/oauth2/authorizations

GET /api/v0/users/me/oauth2/authorizations HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "grant_id": "text",
      "grant_issued_at": "2026-01-01T00:00:00.000Z",
      "app_name": "text",
      "app_display_name": "text",
      "app_client_id": "text",
      "app_provenance": "dcr",
      "scope": [
        "text"
      ]
    }
  ]
}

delete

Revokes the specified OAuth2 authorization (grant) of the currently authenticated user.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Path parameters

idstringRequired

Identifier of the OAuth2 authorization grant to revoke.

Responses

204

Happy response. The authorization was revoked or did not exist.

No content

default

Error object.

application/json

delete/api/v0/users/me/oauth2/authorizations/{id}

DELETE /api/v0/users/me/oauth2/authorizations/{id} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

post

Authorises the client to act on behalf of the principal that makes the request.

Authorizations

AuthorizationstringRequired

The bearer token can be obtained by creating a ServiceAccount.

Body

client_idstringRequired

redirect_uristringRequired

response_typestringRequired

scopestring[]Required

statestringRequired

code_challengestringOptional

code_challenge_methodstringOptional

Responses

200

Happy response.

application/json

redirect_uristringRequired

default

Error object.

application/json

post/api/v1/oauth2/authorize

POST /api/v1/oauth2/authorize HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 152

{
  "client_id": "text",
  "redirect_uri": "text",
  "response_type": "text",
  "scope": [
    "text"
  ],
  "state": "text",
  "code_challenge": "text",
  "code_challenge_method": "text"
}

{
  "redirect_uri": "text"
}