Skip to main content

Interface: OAuthClient

Defined in: oauthServerTypes.ts:68

A registered OAuth client as persisted by the app's ClientStore.

Extends​

Indexable​

[key: string]: unknown

Properties​

client_id​

client_id: string

Defined in: oauthServerTypes.ts:70

Unique client identifier issued by the authorization server.

client_id_issued_at?​

optional client_id_issued_at?: number

Defined in: oauthServerTypes.ts:74

Unix timestamp (seconds) when the client was registered.

client_name?​

optional client_name?: string

Defined in: oauthServerTypes.ts:51

Human-readable client name shown on consent screens.

Inherited from​

OAuthClientMetadata.client_name

client_secret?​

optional client_secret?: string

Defined in: oauthServerTypes.ts:72

Client secret for confidential clients. Absent for public clients.

grant_types?​

optional grant_types?: string[]

Defined in: oauthServerTypes.ts:53

OAuth grant types the client will use. Defaults to auth-code + refresh.

Inherited from​

OAuthClientMetadata.grant_types

redirect_uris​

redirect_uris: string[]

Defined in: oauthServerTypes.ts:49

Allowed redirect URIs. At least one is required for the auth-code flow.

Inherited from​

OAuthClientMetadata.redirect_uris

response_types?​

optional response_types?: string[]

Defined in: oauthServerTypes.ts:55

OAuth response types the client will use. Defaults to ['code'].

Inherited from​

OAuthClientMetadata.response_types

scope?​

optional scope?: string

Defined in: oauthServerTypes.ts:63

Space-separated scopes the client may request.

Inherited from​

OAuthClientMetadata.scope

token_endpoint_auth_method?​

optional token_endpoint_auth_method?: string

Defined in: oauthServerTypes.ts:61

Client authentication method at the token endpoint. 'none' registers a public client (no secret issued); anything else registers a confidential client and a client_secret is generated.

Inherited from​

OAuthClientMetadata.token_endpoint_auth_method