Get Account Authentication Settings

GET 
https://useast.api.elasticpath.com/v2/settings/account-authentication

Use this endpoint to view account authentication settings

Responses

200

OK

application/json

Schema

Schema

typestring
Specifies the the type of object. Set this value to account_authentication_settings.
Default value: account_authentication_settings
enable_self_signupboolean
Set to true to enable self signup.
Example: true
auto_create_account_for_account_membersboolean
This will automatically create an account for each new account member, using the account member’s name as the account name.
Example: true
account_member_self_managementstring
Whether a user with an 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 be able to update their own account member details (e.g., name, email, and if applicable their username and password). The user can update their own account member details by updating their User Authentication Info using the account_member_id retrieved from the meta in the response of Generating an Account Management Authentication Token as the id and find the authentication credentials to update by calling the Get All User Authentication Password Profile Info endpoint.
Possible values: [disabled, update_only]
Default value: disabled
account_management_authentication_token_timeout_secsinteger
The expiry time for Account Management Authentication Token in seconds. If you want to implement idle timout for you application, see Implementing Idle Timeout
Default value: 86400
Example: 86400
iduuid
The unique identifier.
Example: deb6b25f-8451-4211-9a22-95610333df23
relationships object
authentication_realm object
data object
iduuid
The ID of the authentication realm entity.
Example: 3418c54e-d768-42c1-a9db-d7afd2a18452
typestring
The type of the authentication realm entity.
Default value: authentication_realm
links object
selfstring
A URL to the specific resource.
Example: https://useast.api.elasticpath.com/v2/authentication-realms/3418c54e-d768-42c1-a9db-d7afd2a18452
meta object
client_idstring
The client ID to be used in Single Sign On authentication flows for accounts.
Example: account-management
links object
selfstring
A URL to the specific resource.
Example: https://useast.api.elasticpath.com/v2/account_authentication_settings

Example (auto)

{
  "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"
  }
}

401

Unauthorized

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

unauthorized-error

{
  "errors": [
    {
      "title": "Unauthorized",
      "status": "401"
    }
  ]
}

default

Internal server error.

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstringrequired
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Authorization: http

name: BearerTokentype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/settings/account-authentication");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

ResponseClear

Click the Send API Request button above and see the response here!