Account

Update an account

Updates an account.

put/v3/accounts/{id}

Request

  • Base URL: https://demo.api.zephr.com
  • URL: https://demo.api.zephr.com/v3/accounts/{id}
  • Auth: HTTP zephr-hmac-*

Path parameters

idstring required

Unique Account identifier

Request body

company_idstring
namestring
number_of_seatsnumber
allow_oversubscriptionboolean
notify_when_account_oversubscribedboolean
notify_on_each_registration_when_account_is_oversubscribedboolean
registration_codestring
on_premises_ipsstring

A list of newline-separated IP addresses or CIDR blocks that identify the premises associated with this account.

premises_tagsstring

(string) A JSON array of strings of 'tags'. Tags can be used to identify and group accounts to drive behaviour in the Zephr decision engine.

session_limitnumber

The maximum number of concurrent sessions that users of this account can have. If unspecified, the system default value is used. If a user belongs to multiple accounts, the highest limit is used.

session_limit_behaviourstring

One of "PREVENT_LOGIN" or "DELETE_OLDEST_SESSIONS". Specifies the behaviour when a user of this account exceeds the configured limit of concurrent sessions.

Example request

{
  "company_id": "123456789ABCD",
  "name": "Account name",
  "number_of_seats": 5,
  "allow_oversubscription": true,
  "notify_when_account_oversubscribed": true,
  "notify_on_each_registration_when_account_is_oversubscribed": true,
  "registration_code": "Registration code",
  "on_premises_ips": "125.124.143.24",
  "premises_tags": "[\"gold-tier\", \"university\"]",
  "session_limit": 10,
  "session_limit_behaviour": "PREVENT_LOGIN"
}

Response

Created

Changes

No recorded changes to this operation across all 1 revision of this API.