Developer docs
/
Rebilly API
/
Customer authentication
/
Change authentication options

Change authentication options

Changes customer authentication options.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
Request Body schema: application/json
required

Authentication options resource.

passwordPattern
string or null

Allowed password pattern.

credentialTtl
integer

Default credential lifetime, in seconds.

authTokenTtl
integer

Default auth-token lifetime, in seconds.

resetTokenTtl
integer

Default reset-token lifetime, in seconds.

otpRequired
boolean

Specifies if a One-Time Password (OTP) is required to exchange a token.

put
/authentication-options
Request samples
application/json
{
"passwordPattern": "/^[0-9]+$/",
"credentialTtl": 0,
"authTokenTtl": 0,
"resetTokenTtl": 0,
"otpRequired": true
}
Responses

200

Authentication options updated.

Response Schema: application/json
passwordPattern
string or null

Allowed password pattern.

credentialTtl
integer

Default credential lifetime, in seconds.

authTokenTtl
integer

Default auth-token lifetime, in seconds.

resetTokenTtl
integer

Default reset-token lifetime, in seconds.

otpRequired
boolean

Specifies if a One-Time Password (OTP) is required to exchange a token.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

Response samples
application/json
{
"passwordPattern": "/^[0-9]+$/",
"credentialTtl": 0,
"authTokenTtl": 0,
"resetTokenTtl": 0,
"otpRequired": true,
"_links": [

]
}