endstate.settings.auth.update

    update(body: UpdateAuthSettingsRequest, options?: RequestOptions): Promise<AuthSettingsResponse>


Endpoint	`PUT /v1/settings/auth`
Credential	Secret key (`end_sk_...`)
Retry class	`write`

Never repeated. The API accepts no idempotency key here, so a second send is a second write. Only 429 rate_limit.exceeded is retried.

Example

const result = await endstate.settings.auth.update({
  issuer: "https://auth.brand.example",
  jwks_url: "https://auth.brand.example/.well-known/jwks.json",
  audience: "https://wallet.brand.example",
});

Parameters

string

required

The iss your identity tokens carry. Matched exactly, so it must be stable across key rotation.

string

required

A public, cacheable JWKS URL Endstate fetches to verify your tokens. HTTPS only.

string

required

The aud your identity tokens carry. Use a value dedicated to Endstate so your other tokens cannot be presented here.

Returns

200 - AuthSettingsResponse.

'endstate' | 'external'

required

external when your own token issuer is registered; endstate when identity is managed by Endstate.

string | null

required

The registered token issuer (iss), or null when unset.

string | null

required

The registered JWKS URL, or null when unset.

string | null

required

The audience (aud) your identity tokens carry, or null when unset.

Errors

Branch on error.code, never on the HTTP status - several codes share one.

Code	HTTP	Retry
`auth.unauthorized`	401	Do not retry
`internal.error`	500	Safe to retry
`validation.failed`	400	Do not retry

See Errors and retries for the error types and how to narrow them.

Get started

Core SDK

Reader SDK

endstate.settings.auth.update

Example

Parameters

Returns

Errors

​Example

​Parameters

​Returns

​Errors

Example

Parameters

Returns

Errors