Powered by Redocly

Token TTL

Tenant-wide defaults and ceilings for authentication token TTLs. These values apply when a specific authentication method does not override them.

Update the token tenant settings

Global token configuration for this tenant. Overrides system defaults for token TTL and other token behavior.

SecurityaccessToken
Request
query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
default-ttl
string <duration>
Default: "32d"

A duration in years, days, hours, minutes and seconds.

Format is [<digits>y][<digits>d][<digits>m][<digits>s].

Examples: 1y2d5h, 5h or 10m30s

Tenant-wide default lifetime applied to issued tokens when no TTL is supplied at login time. Individual authentication methods and roles may override this with their own token-ttl. The effective TTL is always capped by max-ttl.

max-ttl
string <duration>
Default: "32d"

A duration in years, days, hours, minutes and seconds.

Format is [<digits>y][<digits>d][<digits>m][<digits>s].

Examples: 1y2d5h, 5h or 10m30s

Tenant-wide upper bound on the lifetime of any issued token. Caps both default-ttl and any per-method or per-role token-ttl / token-max-ttl. Requests for longer TTLs are silently truncated to this value.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

patch/v1/config/strongbox/authentication/token-settings
Request samples 
default-ttl: 32d
max-ttl: 32d

Delete the token tenant settings

Global token configuration for this tenant. Overrides system defaults for token TTL and other token behavior.

SecurityaccessToken
Request
query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

delete/v1/config/strongbox/authentication/token-settings

Replace or create the token tenant settings

Global token configuration for this tenant. Overrides system defaults for token TTL and other token behavior.

SecurityaccessToken
Request
query Parameters
validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Request Body schema:
default-ttl
string <duration>
Default: "32d"

A duration in years, days, hours, minutes and seconds.

Format is [<digits>y][<digits>d][<digits>m][<digits>s].

Examples: 1y2d5h, 5h or 10m30s

Tenant-wide default lifetime applied to issued tokens when no TTL is supplied at login time. Individual authentication methods and roles may override this with their own token-ttl. The effective TTL is always capped by max-ttl.

max-ttl
string <duration>
Default: "32d"

A duration in years, days, hours, minutes and seconds.

Format is [<digits>y][<digits>d][<digits>m][<digits>s].

Examples: 1y2d5h, 5h or 10m30s

Tenant-wide upper bound on the lifetime of any issued token. Caps both default-ttl and any per-method or per-role token-ttl / token-max-ttl. Requests for longer TTLs are silently truncated to this value.

Responses
201

Created

204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

put/v1/config/strongbox/authentication/token-settings
Request samples 
default-ttl: 32d
max-ttl: 32d

Retrieve the configuration of token tenant settings

Global token configuration for this tenant. Overrides system defaults for token TTL and other token behavior.

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

validate
string <enumeration>

Validate the request but do not actually perform the requested operation

Value: "true"
Responses
200

OK

304

Not Modified

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

412

Precondition Failed

503

Service Unavailable (strongbox sealed)

get/v1/config/strongbox/authentication/token-settings
Response samples 
default-ttl: 32d
max-ttl: 32d

Retrieve the the state of token tenant settings

Global token configuration for this tenant. Overrides system defaults for token TTL and other token behavior.

SecurityaccessToken
Request
query Parameters
fields
string

Retrieve only requested fields from the resource

See section fields

site
string

Send the request to the specfifed site

content
string <enumeration>

Filter descendant nodes in the response

Enum: "config" "nonconfig"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

get/v1/state/strongbox/authentication/token-settings
Response samples 
default-ttl: 32d
max-ttl: 32d
➔ Next to Policy