Skip to main content

OAuthClient

@webda/oauth


Interface: OAuthClient

Defined in: packages/oauth/src/parameters.ts:4

OAuth client definition

Properties​

allowedScopes?​

optional allowedScopes?: string

Defined in: packages/oauth/src/parameters.ts:18

Maximum scope ever granted


client_uri?​

optional client_uri?: string

Defined in: packages/oauth/src/parameters.ts:14

Home page


defaultResource?​

optional defaultResource?: string

Defined in: packages/oauth/src/parameters.ts:23

Resource the tokens are bound to when the request names none (RFC 8707): the absolute URI of a registered protected resource


defaultScope?​

optional defaultScope?: string

Defined in: packages/oauth/src/parameters.ts:16

Scope when the request has none


deviceFlow?​

optional deviceFlow?: boolean

Defined in: packages/oauth/src/parameters.ts:25

Device authorization grant allowed


id​

id: string

Defined in: packages/oauth/src/parameters.ts:6

client_id


optional logo?: string

Defined in: packages/oauth/src/parameters.ts:12

Logo URL


metadataDocument?​

optional metadataDocument?: boolean

Defined in: packages/oauth/src/parameters.ts:27

Loaded from a Client ID Metadata Document


name​

name: string

Defined in: packages/oauth/src/parameters.ts:8

Display name


redirect_uris​

redirect_uris: string[]

Defined in: packages/oauth/src/parameters.ts:10

Allowed redirect URIs; loopback http URIs match any port


registered?​

optional registered?: boolean

Defined in: packages/oauth/src/parameters.ts:29

Registered dynamically (RFC 7591)