Account registration settings

Use account registration settings operations to configure the fields and steps that customers see during account registration.

Operations

Retrieve account registration settings
Experimental

Request

Retrieves a list of all account registration settings.

Security
SecretApiKey or JWT
Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/account-registration-settings?limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of account registration settings retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
idstring, <= 50 characters^[a-z0-9\-]+$

ID of the account registration settings. If not provided, the ID is generated from the name.

Example:"eu-registration"
namestring, [ 1 .. 255 ] charactersrequired

Name of the account registration settings.

Example:"EU Registration Requirements"
descriptionstring or null, <= 1000 characters

Description of the account registration settings.

Example:"Account registration settings for EU customers"
isEnabledboolean

Specifies if the account registration settings are active.

Default:true
Example:true
locationsArray of objects

List of locations that the account registration settings apply to. Each location consists of a country and an optional region.

Example:
[
  {
    "country": "CA",
    "region": "ON"
  },
  {
    "country": "GB"
  }
]
fieldsArray of objects(RegistrationField)

List of registration fields that define the registration form.

realmstring or nullread-only

Keycloak realm associated with the account registration settings.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

]
Response
[
  {
    "id": "eu-registration",
    "name": "EU Registration Requirements",
    "description": "Account registration settings for EU customers",
    "isEnabled": true,
    "locations": [ … ],
    "fields": [ … ],
    "realm": "string",
    "createdTime": "2019-08-24T14:15:22Z",
    "updatedTime": "2019-08-24T14:15:22Z",
    "_links": [ … ]
  }
]