Rebilly API Docs

Retrieve authentication options

Retrieves customer authentication options.

SecuritySecretApiKey or JWT

Responses

200

Authentication options retrieved.

passwordPattern	string 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.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/authentication-options

Request samples

$authenticationOptions = $client->authenticationOptions()->load();

Response samples

application/json

{"passwordPattern": "string",
"credentialTtl": 0,
"authTokenTtl": 0,
"resetTokenTtl": 0,
"otpRequired": true
}