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

Retrieve authentication options

Retrieves customer authentication options.

SecurityAPI Key: SecretApiKey or HTTP: JWT
get
/authentication-options
Request samples
$authenticationOptions = $client->authenticationOptions()->load();
Responses

200

Authentication options retrieved.

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.

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

]
}