Get Account Authentication Settings

GET 
/v2/settings/account-authentication

Use this endpoint to view account authentication settings

Responses

200

OK

application/json

Schema

Schema

type string

Default value: account_authentication_settings

Specifies the the type of object. Set this value to account_authentication_settings.

enable_self_signup boolean

Set to true to enable self signup.

auto_create_account_for_account_members boolean

This will automatically create an account for every account member with name and legal name matching with that of the account.

account_member_self_management string

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.

account_management_authentication_token_timeout_secs integer

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

id UUID (string)

The unique identifier.

relationships object

authentication_realm object

data object

id string

The ID of the authentication realm entity.

type string

Default value: authentication_realm

The type of the authentication realm entity.

links object

self string

A URL to the specific resource.

meta object

client_id string

The client ID to be used in Single Sign On authentication flows for accounts.

links object

self string

A URL to the specific resource.

Example (from schema)

{
  "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 [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "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 [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

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

Loading...