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

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.userGrants.list({
        perPage: 1,
        page: 1,
        includeTotals: true,
        userId: "user_id",
        clientId: "client_id",
        audience: "audience",
    });
}
main();
[
  {
    "id": "<string>",
    "clientID": "<string>",
    "user_id": "<string>",
    "audience": "<string>",
    "scope": [
      "<string>"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
per_page
integer

Number of results per page.

Required range: 1 <= x <= 100
​
page
integer

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

Required range: x >= 0
​
include_totals
boolean

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

​
user_id
string

user_id of the grants to retrieve.

​
client_id
string

client_id of the grants to retrieve.

​
audience
string

audience of the grants to retrieve.

Response

Grants successfully retrieved.

​
id
string

ID of the grant.

​
clientID
string

ID of the client.

​
user_id
string

ID of the user.

​
audience
string

Audience of the grant.

​
scope
string[]

Scopes included in this grant.

Minimum string length: 1