v1

latestOpenAPI 3.0.0UNLICENSED2026-07-26178479713.7 KB
grants

aid_auths_client_grants_get

Manage your Client Grants (also called Client Credentials Grants). Using Client Grants, your Client can request an access token using its credentials (a Client ID and a Client Secret). The access token then represents your Client during API calls.

Use the Grant type to limit how the grant can be used when requesting an access token. A Grant with type password can only be used when requesting an access token with grant_type set to password.

scopes:

  • admin:accounts
  • read:accounts
get/accounts/{oid}/auth/client-grants

Path parameters

oidstring ^[PT]{1}(?=(?:.{3}|.{8})$)[0-9]*$ required

An id that uniquely identifies the account or owner (partner)

Query parameters

audiencestring

filter client grants by audience

client_idstring

filter client grants by client_id

Response

Grant Collection

idstring uuid

An UUID that uniquely identifies the resource

created_atstring date-time

The date-time when the resource was created

created_bystring

The ID of the user/client created the resource

updated_atstring date-time

The date-time when the resource was last updated

deleted_bystring

The ID of the user/client created the resource

deleted_atstring date-time
client_idstring required
audiencestring required
scopestring[] required
type'any' | 'authorization_code' | 'client_credentials' | 'password'

Limit the usage of the grant. A grant with grant_types set to only authorization_code cannot be used in Get Token when calling the endpoint with grant_type=client_credentials

Example response

[
  {
    "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
    "audience": "https://api.dintero.com/v1/accounts/P00000000",
    "scope": [
      "receipts:write"
    ],
    "oidc": {
      "authority": "https://identityserver.example.com/access"
    }
  }
]