Skip to main content

Class: ClientSQL

Defined in: auth/src/models/sql/ClientSQL.ts:39

Implementation of the Client interface for storage in a SQL database. If MongoDB is desired, please use models.mongo.ClientMongo instead.

Extends​

  • BaseEntity

Implements​

Constructors​

Constructor​

new ClientSQL(other?): ClientSQL

Defined in: auth/src/models/sql/ClientSQL.ts:120

Parameters​

other?​

Partial<ClientSQL>

Returns​

ClientSQL

Overrides​

BaseEntity.constructor

Properties​

clientName​

clientName: string = ""

Defined in: auth/src/models/sql/ClientSQL.ts:48

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

Implementation of​

Client.clientName

clientSecretHash?​

optional clientSecretHash?: string

Defined in: auth/src/models/sql/ClientSQL.ts:42

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

Implementation of​

Client.clientSecretHash

clientType​

clientType: ClientType = ClientType.CONFIDENTIAL

Defined in: auth/src/models/sql/ClientSQL.ts:45

Whether this client can maintain the confidentiality of its credentials.

Implementation of​

Client.clientType

clientUri?​

optional clientUri?: string

Defined in: auth/src/models/sql/ClientSQL.ts:86

A URI to the client's home page.

Implementation of​

Client.clientUri

contacts?​

optional contacts?: string[]

Defined in: auth/src/models/sql/ClientSQL.ts:78

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

Implementation of​

Client.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.

Implementation of​

Client.dateCreated

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.

Implementation of​

Client.dateModified

Inherited from​

BaseEntity.dateModified

disabled?​

optional disabled?: boolean

Defined in: auth/src/models/sql/ClientSQL.ts:118

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

Implementation of​

Client.disabled

firstParty​

firstParty: boolean = false

Defined in: auth/src/models/sql/ClientSQL.ts:110

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.

Implementation of​

Client.firstParty

grantTypes​

grantTypes: string[] = []

Defined in: auth/src/models/sql/ClientSQL.ts:54

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

Implementation of​

Client.grantTypes

jwks?​

optional jwks?: any

Defined in: auth/src/models/sql/ClientSQL.ts:74

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

Implementation of​

Client.jwks

jwksUri?​

optional jwksUri?: string

Defined in: auth/src/models/sql/ClientSQL.ts:70

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

Implementation of​

Client.jwksUri

logoUri?​

optional logoUri?: string

Defined in: auth/src/models/sql/ClientSQL.ts:82

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

Implementation of​

Client.logoUri

ownerUid?​

optional ownerUid?: string

Defined in: auth/src/models/sql/ClientSQL.ts:107

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

Implementation of​

Client.ownerUid

policyUri?​

optional policyUri?: string

Defined in: auth/src/models/sql/ClientSQL.ts:94

A URI to the client's privacy policy.

Implementation of​

Client.policyUri

redirectUris​

redirectUris: string[] = []

Defined in: auth/src/models/sql/ClientSQL.ts:51

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

Implementation of​

Client.redirectUris

registrationAccessTokenHash?​

optional registrationAccessTokenHash?: string

Defined in: auth/src/models/sql/ClientSQL.ts:114

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

Implementation of​

Client.registrationAccessTokenHash

requirePkce​

requirePkce: boolean = false

Defined in: auth/src/models/sql/ClientSQL.ts:66

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

Implementation of​

Client.requirePkce

responseTypes​

responseTypes: string[] = []

Defined in: auth/src/models/sql/ClientSQL.ts:57

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

Implementation of​

Client.responseTypes

scope​

scope: string = ""

Defined in: auth/src/models/sql/ClientSQL.ts:60

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

Implementation of​

Client.scope

softwareId?​

optional softwareId?: string

Defined in: auth/src/models/sql/ClientSQL.ts:98

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

Implementation of​

Client.softwareId

softwareVersion?​

optional softwareVersion?: string

Defined in: auth/src/models/sql/ClientSQL.ts:102

The version of the client software.

Implementation of​

Client.softwareVersion

tokenEndpointAuthMethod​

tokenEndpointAuthMethod: TokenEndpointAuthMethod = TokenEndpointAuthMethod.CLIENT_SECRET_BASIC

Defined in: auth/src/models/sql/ClientSQL.ts:63

How this client authenticates itself to the token endpoint.

Implementation of​

Client.tokenEndpointAuthMethod

tosUri?​

optional tosUri?: string

Defined in: auth/src/models/sql/ClientSQL.ts:90

A URI to the client's terms of service.

Implementation of​

Client.tosUri

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.

Implementation of​

Client.uid

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.

Implementation of​

Client.version

Inherited from​

BaseEntity.version