Auth0 API | Client Grants › Get Client Grants

Client Grants

client_grants

Methods

Create Client Grant ->

ClientGrant

post/client-grants

Create a client grant for a machine-to-machine login flow. To learn more, read Client Credential Flow.

Delete Client Grant ->

delete/client-grants/{id}

Delete the Client Credential Flow from your machine-to-machine application.

Get Client Grants -> ClientGrantsPageNumberPage<

ClientGrant

get/client-grants

Retrieve a list of client grants, including the scopes associated with the application/API pair.

Security

Example: Authorization: Bearer My Bearer Token

Parameters

allow_any_organization:

Optional

Optional filter on allow_any_organization.

true

audience: string

Optional

Optional filter on audience.

client_id: string

Optional

Optional filter on client_id.

from: string

Optional

Optional Id from which to start selection.

include_totals: boolean

Optional

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

page: number

Optional

(minimum: 0)

Page index of the results to return. First page is 0.

per_page: number

Optional

(maximum: 100, minimum: 1)

Number of results per page.

take: number

Optional

(maximum: 100, minimum: 1)

Number of results per page. Defaults to 50.

Response fields

UnionMember0 = Array<

ClientGrant

UnionMember1 = { client_grants, limit, start, 1 more... }

UnionMember2 = { client_grants, next }

Request example

curl https://login0.local.dev.auth0.com/api/v2/client-grants \
    -H "Authorization: Bearer $BEARER_TOKEN"

200Example

[
  {
    "id": "id",
    "allow_any_organization": true,
    "audience": "x",
    "client_id": "client_id",
    "organization_usage": "deny",
    "scope": [
      "x"
    ]
  }
]

Update Client Grant ->

ClientGrant

patch/client-grants/{id}

Update a client grant.

Domain types

ClientGrant = { id, allow_any_organization, audience, 3 more... }