Skip to main content

Interface: AuthorizationCode

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

Defines a single, one-time-use OAuth 2.0 authorization code (RFC 6749 §4.1.2), issued by BaseOAuthAuthorizeRoute and redeemed by BaseOAuthTokenRoute's authorization_code grant.

Extends​

  • BaseEntity

Properties​

clientId​

clientId: string

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

The uid of the Client this code was issued to.

codeChallenge?​

optional codeChallenge?: string

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

The RFC 7636 PKCE code challenge, if the client used PKCE.

codeChallengeMethod?​

optional codeChallengeMethod?: "S256" | "plain"

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

The method used to derive codeChallenge from the client's code_verifier.

codeHash​

codeHash: string

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

The SHA-256 hex digest of the opaque code. The raw code itself is never persisted.

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

expiresAt​

expiresAt: Date

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

When this code expires — typically ~60 seconds after issuance.

nonce?​

optional nonce?: string

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

The OIDC nonce to carry into the id_token, if the client requested the openid scope.

redirectUri​

redirectUri: string

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

The exact redirect_uri presented at /authorize — must match exactly again at /token.

scope​

scope: string

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

The space-delimited set of scopes granted.

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

used​

used: boolean

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

Set to true once this code has been redeemed at /token. A second presentation of an already-used code is treated as a replay/leak: see BaseOAuthTokenRoute.

userUid​

userUid: string

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

The uid of the User (resource owner) who authorized this code.

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