Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

Authentication

Get login status of current session

Get login status of current session.

get/login

Response

OK

access_tokenstring

Access token to be passed as a header

expires_atstring date_time

The expiration date of the access token in RFC 3339 format, for example, 2017-07-21T17:32:28Z. The RFC 3339 format is defined by RFC 3339, section 5.6

expires_ininteger

The number of seconds that the access token will be valid.

rolestring

Roles include built-in roles and custom roles.
Built-in roles roles cannot be modified.
Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion.
Built-in roles include:

  • SystemAdmin: the system administrator has almost all permissions.
  • Replicator: the application permissions collection.
  • Dealer: the sales manager has all sold tenant resource permissions
  • Admin: the admin has all tenant-wide resource permissions.
  • StandardUser: the user all user-wide resource permissions.
  • StandardInternationalUser: the user all user-wide resource permissions with international call permissions.
  • QueueManager: The call queue manager.

Example response

{
  "access_token": "4DFCF1D4C30B4D798ECE3AE43769F008.",
  "expires_at": "2017-07-21T17:32:28Z",
  "expires_in": 1800,
  "role": "User"
}