Sign in

v1

latestOpenAPI 3.0.02026-08-06165119238.1 KB
Account

Retrieve an account

Retrieves an account.

get/v3/accounts/{id}

Path parameters

idstring required

Unique Account identifier

Response

OK

company_idstring
namestring
number_of_seatsnumber
allow_oversubscriptionboolean
notify_when_account_oversubscribedboolean
notify_on_each_registration_when_account_is_oversubscribedboolean
registration_codestring
ip_addressesstring
registration_domainsstring
email_addressstring
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.