Get Account Authentication Settings
GEThttps://useast.api.elasticpath.com/v2/settings/account-authentication
Use this endpoint to view account authentication settings
Responses
- 200
- 401
- default
OK
- application/json
- Schema
- Example (from schema)
Schema
Default value: account_authentication_settings
Specifies the the type of object. Set this value to account_authentication_settings
.
Set to true
to enable self signup.
This will automatically create an account for every account member with name and legal name matching with that of the account.
Possible values: [disabled
, update_only
]
Default value: disabled
Whether a user with Account Management Authentication Token can update their own account member details. By default, this is disabled. Set to update_only
if you want the user to update their own account member details. The user can update their own account member details by updating User Authentication Info and User Authentication Password Profile Info.
Default value: 86400
The expiry time for Account Management Authentication Token in seconds. If you want to implement idle timout for you application, see Implementing Idle Timeout
The unique identifier.
relationships object
meta object
links object
{
"type": "account_authentication_settings",
"enable_self_signup": true,
"auto_create_account_for_account_members": true,
"account_member_self_management": "disabled",
"account_management_authentication_token_timeout_secs": 86400,
"id": "deb6b25f-8451-4211-9a22-95610333df23",
"relationships": {
"authentication_realm": {
"data": {
"id": "3418c54e-d768-42c1-a9db-d7afd2a18452",
"type": "authentication_realm",
"links": {
"self": "https://useast.api.elasticpath.com/v2/authentication-realms/3418c54e-d768-42c1-a9db-d7afd2a18452"
}
}
}
},
"meta": {
"client_id": "account-management"
},
"links": {
"self": "https://useast.api.elasticpath.com/v2/account_authentication_settings"
}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
- unauthorized-error
Schema
errors Error[]required
{
"errors": [
{
"title": "string",
"status": "string",
"detail": "string"
}
]
}
{
"errors": [
{
"title": "Unauthorized",
"status": "401"
}
]
}
Internal server error.
- application/json
- Schema
- Example (from schema)
- internal-server-error
Schema
errors Error[]required
{
"errors": [
{
"title": "string",
"status": "string",
"detail": "string"
}
]
}
Internal server error
{
"errors": [
{
"title": "Internal Server Error",
"status": "500",
"detail": "there was a problem processing your request"
}
]
}
Authorization: http
name: BearerTokentype: httpscheme: bearer
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L -X GET 'https://useast.api.elasticpath.com/v2/settings/account-authentication' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'