evalink talos
  • evalink talos API Documentation
  • Get started
    • 1. Create a free evalink talos account
    • 2. Create a test set-up in evalink talos
    • 3. About REST – The Basics
    • 4. Get Postman
    • 5. Create your first API Token in evalink talos
    • 6. Make your first REST API call
  • Alarm API
    • Send alarms using simple webhooks
    • Send alarms with content using webhooks and header attachments
    • Send alarms using REST
    • Query alarms
  • Management API
    • Manage users
    • Manage devices
    • Manage groups
    • Manage contacts
    • Manage schedules
    • Manage virtual receivers
    • Manage webhooks
    • Manage workflows
Powered by GitBook
On this page
  • Introduction
  • invite users
  • find users by company ID
  • find a list of users by user IDs
  • find a user by user ID
  • find the roles of a particular user
  • update the roles of a particular user

Was this helpful?

  1. Management API

Manage users

Use this section to add/update/view new users in evalink talos.

Introduction

There are two types of users in evalink talos:

  • Administrator

  • Operator

evalink talos offers the ability to invite new users in your company and select their type (Administrator/Operator). They can then accept the invitation and create an account with their e-mail and password.

Managing users is currently restricted for generated API tokens

invite users

POST https://talos-app.io/api/oauth-service/invitations

Use this endpoint to invite users into your evalink talos tenant.

Headers

Name
Type
Description

Authorization

string

Use 'Bearer' followed by your API token.

Request Body

Name
Type
Description

email

string

The e-mail of the user you would like to invite.

companyId

string

The Company ID, as it is displayed on the evalink talos Web Interface.

companyAdmin

boolean

The admin priviledges for the user you are inviting.

{
  "links": {
    "empty": true
  }
}

Example:

{
  "companyAdmin": true,
  "companyId": "<companyId>",
  "email": "<emailAddress>"
}

find users by company ID

GET https://talos-app.io/api/oauth-service/users/search/findByCompanyId:companyId

Use this endpoint to find the users for a particular company.

Path Parameters

Name
Type
Description

companyId

string

The Company ID, as it is displayed on the evalink talos Web Interface.

Headers

Name
Type
Description

Authorization

string

Use 'Bearer' followed by your API token.

{
  "_embedded": {
    "users": [
      {
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "mfaEnabled": true
      }
    ]
  },
  "_links": {}
}

find a list of users by user IDs

GET https://talps-app.io/api/oauth-service/users/search/findByIdIn

Use this endpoint to receive a list of users based on a collection of user IDs.

Path Parameters

Name
Type
Description

ids

array

The collection of user IDs.

Headers

Name
Type
Description

Authorization

string

Use 'Bearer' followed by your API token.

{
  "_embedded": {
    "users": [
      {
        "email": "string",
        "firstName": "string",
        "id": "string",
        "lastName": "string",
        "mfaEnabled": true
      }
    ]
  },
  "_links": {}
}

find a user by user ID

GET https://talos-app.io/api/oauth-service/users/{id}

Use this endpoint to receive a user by their user ID.

Path Parameters

Name
Type
Description

id

string

The required user ID.

Headers

Name
Type
Description

Authorization

string

Use 'Bearer' followed by your API token.

{
  "email": "string",
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "links": {
    "empty": true
  },
  "mfaEnabled": true
}
{
  "email": "string",
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "links": {
    "empty": true
  },
  "mfaEnabled": true
}

find the roles of a particular user

GET https://talos-app.io/api/oauth-service/users/{id}/roles

Use this endpoint to receive the roles of a particular user by using the user ID.

Path Parameters

Name
Type
Description

id

string

The required user ID.

Headers

Name
Type
Description

Authorization

string

Use 'Bearer' followed by your API token.

{
  "_embedded": {
    "persistentEntityResources": [
      null
    ]
  },
  "_links": {}
}

update the roles of a particular user

POST https://talos-app.io/api/oauth-service/users/{id}/roles

IUse this endpoint tot updates the role of a specific user.

Path Parameters

Name
Type
Description

id

string

The required user ID.

userRoleIds

array

The collection of user role ID.

Headers

Name
Type
Description

Authorization

string

Use 'Bearer' followed by your API token.

{
  "_embedded": {
    "persistentEntityResources": [
      null
    ]
  },
  "_links": {}
}

PreviousQuery alarmsNextManage devices

Last updated 4 years ago

Was this helpful?