v1

latestOpenAPI 3.1.02026-08-042784116.2 KB

List Legal Entity's Account Logins

Lists Account Login for the current Legal Entity.

Retrieving a login's information is a three-step process:

  1. the returned objects will contain, amongst other information, the id of the Account Login.
  2. the hosted url can be obtained by calling /logins/<id>/sessions
  3. the Account Login data will be available following the previous response's url

Example

  1. Request all logins for the current Legal Entity: /logins
  2. Response:
    [
       {
         "id": "abc1234",
         "name": "Account for Tax Office in Nevada",
         "region_code": "NV",
         "login_url": "https://tax.neveda.gov/login",
         "url": "https://tax.neveda.gov/login",
         "is_supported": true,
       },
       ...
    

]

get/logins

Response

Successful Response

idstring required

The identifier of this Account Login

namestring required

The name of the Login

location_idstring required

The location id the login belongs to

login_urlstring required

This field is deprecated, please use url.

urlstring required

The url pointing to the login page for this Login