Skip to main content

Interface: Client

Defined in: auth/src/models/types.ts:205

Defines a single OAuth 2.0 / OpenID Connect client application registered with this authorization server.

Extends​

  • BaseEntity

Properties​

clientName​

clientName: string

Defined in: auth/src/models/types.ts:213

A human-readable name for the client, shown on a consent screen.

clientSecretHash?​

optional clientSecretHash?: string

Defined in: auth/src/models/types.ts:207

The Argon2id hash of the client's secret. Unset for a PUBLIC client.

clientType​

clientType: ClientType

Defined in: auth/src/models/types.ts:210

Whether this client can maintain the confidentiality of its credentials.

clientUri?​

optional clientUri?: string

Defined in: auth/src/models/types.ts:246

A URI to the client's home page.

contacts?​

optional contacts?: string[]

Defined in: auth/src/models/types.ts:240

Contact addresses for the people/team responsible for this client (RFC 7591 contacts).

dateCreated​

dateCreated: Date

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:18

The date and time that the entity was created.

Inherited from​

BaseEntity.dateCreated

dateModified​

dateModified: Date

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:22

The date and time that the entity was last modified.

Inherited from​

BaseEntity.dateModified

disabled?​

optional disabled?: boolean

Defined in: auth/src/models/types.ts:273

Set to true to reject every authorization/token request for this client.

firstParty​

firstParty: boolean

Defined in: auth/src/models/types.ts:267

Set to true to skip the consent screen for this client. Only ever set by a downstream admin path — never settable via dynamic client registration, which always registers a third-party client.

grantTypes​

grantTypes: string[]

Defined in: auth/src/models/types.ts:219

The OAuth grant types this client is permitted to use (e.g. authorization_code, refresh_token).

jwks?​

optional jwks?: any

Defined in: auth/src/models/types.ts:237

This client's JWK set inline, as an alternative to jwksUri.

jwksUri?​

optional jwksUri?: string

Defined in: auth/src/models/types.ts:234

The URI to fetch this client's JWK set from, for future private_key_jwt support.

logoUri?​

optional logoUri?: string

Defined in: auth/src/models/types.ts:243

A URI to the client's logo, shown on a consent screen.

ownerUid?​

optional ownerUid?: string

Defined in: auth/src/models/types.ts:261

The uid of the User who registered this client, if registered by an authenticated user.

policyUri?​

optional policyUri?: string

Defined in: auth/src/models/types.ts:252

A URI to the client's privacy policy.

redirectUris​

redirectUris: string[]

Defined in: auth/src/models/types.ts:216

The exact-match allow-list of redirect URIs this client may request tokens be delivered to.

registrationAccessTokenHash?​

optional registrationAccessTokenHash?: string

Defined in: auth/src/models/types.ts:270

The Argon2id hash of this client's RFC 7592 registration access token, used to manage its own registration.

requirePkce​

requirePkce: boolean

Defined in: auth/src/models/types.ts:231

Whether PKCE is required for this client. Always true for a PUBLIC client, regardless of what was requested at registration.

responseTypes​

responseTypes: string[]

Defined in: auth/src/models/types.ts:222

The OAuth response types this client is permitted to request (e.g. code).

scope​

scope: string

Defined in: auth/src/models/types.ts:225

The space-delimited set of scopes this client may request.

softwareId?​

optional softwareId?: string

Defined in: auth/src/models/types.ts:255

An identifier for the client software, shared across every instance of it (RFC 7591 software_id).

softwareVersion?​

optional softwareVersion?: string

Defined in: auth/src/models/types.ts:258

The version of the client software.

tokenEndpointAuthMethod​

tokenEndpointAuthMethod: TokenEndpointAuthMethod

Defined in: auth/src/models/types.ts:228

How this client authenticates itself to the token endpoint.

tosUri?​

optional tosUri?: string

Defined in: auth/src/models/types.ts:249

A URI to the client's terms of service.

uid​

uid: string

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:14

The universally unique identifier of the entity.

Inherited from​

BaseEntity.uid

version​

version: number

Defined in: auth/node_modules/@rapidrest/service-core/dist/types/models/BaseEntity.d.ts:26

The optimistic lock version.

Inherited from​

BaseEntity.version