Skip to main content

Interface: MachineClientSpec

Defined in: packages/identity/src/port.ts:374

A confidential, service-account-only client: client credentials, no browser flow, no direct grant.

Extends​

  • ClientSpecBase

Properties​

clientId​

readonly clientId: string

Defined in: packages/identity/src/port.ts:357

The OAuth client id. Lowercase, hyphenated.

Inherited from​

ClientSpecBase.clientId

description?​

readonly optional description?: string

Defined in: packages/identity/src/port.ts:359

What it is for.

Inherited from​

ClientSpecBase.description

kind​

readonly kind: "machine"

Defined in: packages/identity/src/port.ts:376

Selects this shape of ClientSpec.

scopes​

readonly scopes: readonly string[]

Defined in: packages/identity/src/port.ts:365

Scopes the client receives by default. Each must exist (ensureScope), and the audience mappers of each must already have been ensured: on WSO2 a client picks up an audience only from mappers that exist when it is ensured.

Inherited from​

ClientSpecBase.scopes

secret​

readonly secret: Secret<string>

Defined in: packages/identity/src/port.ts:382

The secret it must hold. Set from the secret file, never generated by the provider and read back. An existing client is tested with it (a token request) and the secret is set only when the provider refuses it.

tokenLifetimes?​

readonly optional tokenLifetimes?: TokenLifetimes

Defined in: packages/identity/src/port.ts:367

Where the provider keeps lifetimes per client, these are applied; elsewhere they are reported unsupported.

Inherited from​

ClientSpecBase.tokenLifetimes