Back to Node Auth0

Interface ListClientGrantsRequestParameters

docs/interfaces/management.Management.ListClientGrantsRequestParameters.html

5.9.12.6 KB
Original Source

Interface ListClientGrantsRequestParameters

Example

{ * from: "from", * take: 1, * audience: "audience", * client_id: "client_id", * allow_any_organization: true, * subject_type: "client", * default_for: "third_party_clients" * }Copy

interface ListClientGrantsRequestParameters {
from?: string | null;
take?: number | null;
audience?: string | null;
client_id?: string | null;
allow_any_organization?: boolean | null;
subject_type?: Management.ClientGrantSubjectTypeEnum | null;
default_for?: "third_party_clients" | null;
}

Index

Properties

from?take?audience?client_id?allow_any_organization?subject_type?default_for?

Properties

Optionalfrom

from?: string | null

Optional Id from which to start selection.

Optionaltake

take?: number | null

Number of results per page. Defaults to 50.

Optionalaudience

audience?: string | null

Optional filter on audience.

Optionalclient_id

client_id?: string | null

Optional filter on client_id.

Optionalallow_any_organization

allow_any_organization?: boolean | null

Optional filter on allow_any_organization.

Optionalsubject_type

subject_type?: Management.ClientGrantSubjectTypeEnum | null

The type of application access the client grant allows.

Optionaldefault_for

default_for?: "third_party_clients" | null

Applies this client grant as the default for all clients in the specified group. The only accepted value is third_party_clients, which applies the grant to all third-party clients. Per-client grants for the same audience take precedence. Mutually exclusive with client_id.

Settings

Member Visibility

  • Protected
  • Inherited

ThemeOSLightDark

On This Page

Properties fromtakeaudienceclient_idallow_any_organizationsubject_typedefault_for