Skip to main content
GET
/
organizations
/
{id}
/
client-grants
TypeScript
import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.organizations.clientGrants.list("id", {
        audience: "audience",
        clientId: "client_id",
        page: 1,
        perPage: 1,
        includeTotals: true,
    });
}
main();
[
  {
    "id": "<string>",
    "client_id": "<string>",
    "audience": "<string>",
    "scope": [
      "<string>"
    ],
    "organization_usage": "deny",
    "allow_any_organization": true
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Organization identifier.

Maximum string length: 50

Query Parameters

​
audience
string

Optional filter on audience of the client grant.

Maximum string length: 600
​
client_id
string

Optional filter on client_id of the client grant.

​
grant_ids
string<client-grant-id>[]

Optional filter on the ID of the client grant. Must be URL encoded and may be specified multiple times (max 10).
e.g. ../client-grants?grant_ids=id1&grant_ids=id2

​
page
integer

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

Required range: x >= 0
​
per_page
integer

Number of results per page. Defaults to 50.

Required range: 1 <= x <= 100
​
include_totals
boolean

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

Response

Client grants successfully retrieved.

​
id
string

ID of the client grant.

​
client_id
string

ID of the client.

​
audience
string

The audience (API identifier) of this client grant

Minimum string length: 1
​
scope
string[]

Scopes allowed for this client grant.

Minimum string length: 1
​
organization_usage
enum<string>

Defines whether organizations can be used with client credentials exchanges for this grant.

Available options:
deny,
allow,
require
​
allow_any_organization
boolean

If enabled, any organization can be used with this grant. If disabled (default), the grant must be explicitly assigned to the desired organizations.