Interface ListGrantsQueryParams

Interface representing the query parameters for listing grants.

Hierarchy

  • ListGrantsQueryParams

Properties

before? email? grantStatus? ip? limit? offset? orderBy? provider? since? sortBy?

Properties

Optional before

before?: number

Scope grants to a specific point in time by Unix timestamp.

Optional email

email?: string

Filtering your query based on grant email address (if applicable)

Optional grantStatus

grantStatus?: string

Filtering your query based on grant email status (if applicable)

Optional ip

ip?: string

Filtering your query based on grant IP address

Optional limit

limit?: number

The maximum number of objects to return. This field defaults to 10. The maximum allowed value is 200.

Optional offset

offset?: number

Offset grant results by this number.

Optional orderBy

orderBy?: "desc" | "asc"

Specify ascending or descending order.

Optional provider

provider?: Provider

Filtering your query based on OAuth provider

Optional since

since?: number

Scope grants from a specific point in time by Unix timestamp.

Optional sortBy

sortBy?: "createdAt" | "updatedAt"

Sort entries by field name

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc