Login API Admin and Customers/End-Users

Login API Admin and Customers/End-Users

Admin Login

The Login API allows users to obtain a token and access additional information.

Path

Request: POST

Parameters
Name
Value
Requirement
Description
action
Must be "authenticate"
Required

organizationId
Number
Required
ID of the Suite Organization that the user belongs to.
eMail
String
Required
User email address
password
String
Required
User password

Response

A successful response will have the HTTP Status code 200, and the JSON response will contain "status: ok". Example of a successful request:
  1. {
  2.   "status": "ok",
  3.   "user_language": "en_US",
  4.   "user_email": "icareussuite@icareus.com",
  5.   "user_organization_id": 10719,
  6.   "user_organization_features": [
  7.     {
  8.       "id": 13339401,
  9.       "name": "Icareus Studio",
  10.       "value": "0",
  11.       "valueType": 1,
  12.       "contentType": 1,
  13.       "type": 2,
  14.       "key": "studio"
  15.     }
  16.   ],
  17.   "user_name": "TestUser",
  18.   "groupId": 10705,
  19.   "friendly_url": "/icareus1",
  20.   "user_organization_logo": "https://suiterc.icareus.com:443/image/company_logo?img_id=0",
  21.   "user_token": "<user-token>",
  22.   "user_organization_name": "Icareus",
  23.   "user_id": 10703,
  24.   "companyId": 10154
  25. }
A failed response will also have the HTTP Status code of 200, but the JSON response will contain the following:
  1. {
  2.   "status": "error",
  3.   "message": <information about the error>
  4. }

Customers/End-Users

The Login API can be used to obtain a user token, among other information.

Path

Request: POST

Parameters
Name
Value
Requirement
Description
action
Must be "authenticate"
Required

organizationId
Number
Required
ID of the Suite Organization that the user belongs to.
eMail
String
Required
User email address
  role
 Must be "IsmSubscriber"
 Required
 
password
String
Required
User password

Response

A successful response will have the HTTP Status code 200, and the JSON response will contain "status: ok". Example of a successful request:
  1. {
  2.   "status": "ok",
  3.   "user_language": "en_US",
  4.   "user_email": "icareussuite@icareus.com",
  5.   "user_organization_id": 10719,
  6.   "user_organization_features": [
  7.     {
  8.       "id": 13339401,
  9.       "name": "Icareus Studio",
  10.       "value": "0",
  11.       "valueType": 1,
  12.       "contentType": 1,
  13.       "type": 2,
  14.       "key": "studio"
  15.     }
  16.   ],
  17.   "user_name": "TestUser",
  18.   "groupId": 10705,
  19.   "friendly_url": "/icareus1",
  20.   "user_organization_logo": "https://suiterc.icareus.com:443/image/company_logo?img_id=0",
  21.   "user_token": "<user-token>",
  22.   "user_organization_name": "Icareus",
  23.   "user_id": 10703,
  24.   "companyId": 10154
  25. }
A failed response will also have the HTTP Status code of 200, but the JSON response will contain the following:
  1. {
  2.   "status": "error",
  3.   "message": <information about the error>
  4. }

    • Related Articles

    • Managing Users

      Introduction to Users Users are the admin users of Icareus Suite Video Cloud. The available user roles are: Account Administrator Account User Viewer Read more about user rights from Managing Users rights, Teams and Permissions Managing Users Search ...

    • Managing Users

      "Users" mean the admin users of Icareus Suite Video Cloud. The available user roles are: Account Administrator Account User Viewer Read more about user rights from Managing Users rights, Teams and Permissions Managing Users Search Users With Search, ...

    • Teams API

      INTRODUCTION Teams API allows creating and editing Teams. AUTHENTICATION A suite user token obtained via the login API must be provided in the request headers as a bearer token. Authorization: Bearer <user-token> GET TEAMS Provides a way to get a ...

    • Login to Icareus Video Cloud

      Login In order to log in to your account, please go to: https://my3.icareus.com/ This will open a page similar to the one shown below: Fill in your email address - this will act as your user name. Then fill in your password and click "Login". You ...

    • Channels Management API

      Introduction This API is used to manage Linear Channels. Authorization All requests made to the following API endpoints require a token. The token should be provided in the headers as: Authorization: Bearer <token> The token should either be a valid ...