Authentication API

Use the Authentication API to generate, refresh, and manage JSON Web Tokens (JWT) that are required for authorization in all Enterprise Control Room APIs.

The JWT authorization is based on the roles and permission of the user's account that is used in the request body.

An authentication token's default time out is 20 minutes. Note: The default timeout for tokens is configurable.
Include the Authentication token or Bearer token in a header file for requests in other Control Room APIs.
Header file example: -H X-Authorization <authentication token> or Authorization:Bearer <bearer token>

More information: https://helloreverb.com

Contact Info: hello@helloreverb.com

Version: LTS - 2.0.0

All rights reserved

http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

Models

Table of Contents

Auth

Up

post /authentication

Authenticate user (authenticationPost)

<p>Use this endpoint to authenticate a registered user. A successful response returns a JSON object that includes a JWT (JSON Web Token). By default, a token is valid for 20 minutes. Add the JWT to header files of other Control Room APIs for authorization.</p> <ul> <li>The <strong>username</strong> is the name of a Control Room user.</li> <li>The <strong>password</strong> is the password for the specified user.</li> <li>The <strong>apiKey</strong> is required to configure Single Sign On (SSO). It can also be used in place of a password for users that are assigned the <a href="https://docs.automationanywhere.com/csh?context=csh-cloud-control-room-apikey-role">API key generation role</a>.</li> </ul> <blockquote> <p><strong>Note:</strong> <strong>apiKey</strong> or <strong>password</strong> is used to generate a valid token. Both (apiKey and password) cannot be used together in a request body.</p> </blockquote>

Consumes

This API call consumes the following media types via the request header:

application/json

Request body

body AuthRequest (required)

Body Parameter —

Return type

AuthResponseV2

Example data

Content-Type: application/json

{
  "tenantUuid" : "4630ea50-31da-4ae9-912e-ef8b235f883b",
  "permissions" : [ {
    "action" : "View",
    "resourceType" : "Settings"
  }, {
    "action" : "View",
    "resourceType" : "Settings"
  } ],
  "user" : {
    "lastName" : "Doe",
    "multipleLoginAllowed" : false,
    "roles" : [ {
      "name" : "AAE_Bot_Developer",
      "id" : "22"
    }, {
      "name" : "AAE_Bot_Developer",
      "id" : "22"
    } ],
    "principalId" : "9",
    "passwordSet" : true,
    "licenseFeatures" : [ "DEVELOPMENT", "DEVELOPMENT" ],
    "firstName" : "John",
    "emailVerified" : true,
    "deleted" : false,
    "enableAutoLogin" : true,
    "domain" : "domain",
    "id" : "9",
    "email" : "a@a.com",
    "questionsSet" : true,
    "username" : "jdoe"
  },
  "ttlSeconds" : "0",
  "token" : "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZS"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

This is a JSON object that contains the JWT generated for the registered Control Room User. In addition to the JWT this response contains details regarding the users roles, permissions, and licenses. AuthResponseV2

400

Bad Rquest Error

401

Authentication required Error

500

Internal Server error Error

Up

post /authentication/token

Refresh a valid token (authenticationTokenPost)

<p>Use this endpoint to refresh a valid token.</p> <ul> <li>The default token expiration is 20 minutes.</li> <li>The token used for the refresh is expired once a refresh token is generated.</li> </ul> <blockquote> <blockquote> <p><strong>Note:</strong> The default timeout for tokens is configurable.</p> </blockquote> </blockquote>

Request headers

Return type

AuthResponseRefreshV2

Example data

Content-Type: application/json

{
  "tenantUuid" : "4630ea50-31da-4ae9-912e-ef8b235f883b",
  "permissions" : [ {
    "action" : "View",
    "resourceType" : "Settings"
  }, {
    "action" : "View",
    "resourceType" : "Settings"
  } ],
  "user" : {
    "lastName" : "Doe",
    "multipleLoginAllowed" : false,
    "roles" : [ {
      "name" : "AAE_Bot_Developer",
      "id" : "22"
    }, {
      "name" : "AAE_Bot_Developer",
      "id" : "22"
    } ],
    "principalId" : "9",
    "passwordSet" : true,
    "licenseFeatures" : [ "DEVELOPMENT", "DEVELOPMENT" ],
    "firstName" : "John",
    "emailVerified" : true,
    "deleted" : false,
    "enableAutoLogin" : true,
    "domain" : "domain",
    "id" : "9",
    "email" : "a@a.com",
    "questionsSet" : true,
    "username" : "jdoe"
  },
  "ttlSeconds" : "1200",
  "token" : "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZS"
}

Produces

This API call produces the following media types according to the request header; the media type will be conveyed by the response header.

application/json

Responses

200

This is a JSON object containing the refresh token. In addition to the refresh token this response contains details regarding the users roles, permissions, and licenses. AuthResponseRefreshV2

400

Bad Rquest Error

401

Authentication required Error

500

Internal Server error Error

Models

Methods

Table of Contents

AuthRequest
AuthResponseRefreshV2
AuthResponseV2
Error
GlobalPermission
LicenseFeature
RefreshAuthV2Request
RoleBasicV2
UserV2

`AuthRequest` Up

username

String The user's username.

example: jdoe

password (optional)

String The user's password. Either password or apiKey is used. Both cannot be used together.

example: mypassword@123

apiKey (optional)

String apiKey can be used as a password for any authentication type.

example: Vie;Z:IvtAhY0NU7baRLYEeIYUJSKO

multipleLogin (optional)

Boolean Allow or disallow multiple login. For more information on multilogin, see <a href="https://docs.automationanywhere.com/csh?context=csh-multi-login-user">Multi Login user</a>.

example: false

`AuthResponseRefreshV2` Up

token (optional)

String JWT token

example: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZS

user (optional)

UserV2

permissions (optional)

array[GlobalPermission] Permissions assigned to the user.

tenantUuid (optional)

String Tenant uuid of the logged in user

example: 4630ea50-31da-4ae9-912e-ef8b235f883b

ttlSeconds (optional)

String Time in seconds for which the token is active

example: 1200

`AuthResponseV2` Up

token (optional)

String JWT token

example: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZS

user (optional)

UserV2

permissions (optional)

array[GlobalPermission] Permissions assigned to the user.

tenantUuid (optional)

String Tenant uuid of the logged in user

example: 4630ea50-31da-4ae9-912e-ef8b235f883b

ttlSeconds (optional)

String The ttlSeconds parameter is only relevant for refresh tokens. This value is ignored in the initial authentication response.

example: 0

`Error` Up

code (optional)

String Error code

message (optional)

String Message describing error

details (optional)

String More details of the error message

`GlobalPermission` Up

action (optional)

String The action that the user is allowed to perform

example: View

resourceType (optional)

String The resource on which the action is allowed

example: Settings

`LicenseFeature` Up

License feature

`RefreshAuthV2Request` Up

token (optional)

String current JWT token. Enter the token you want to refresh.

example: eyJhbGciOiJSUzUxMiJ9.eyJzdWI

`RoleBasicV2` Up

id (optional)

String Unique identifier representing a specific role

example: 22

name

String Name of role

example: AAE_Bot_Developer

`UserV2` Up

id (optional)

String Unique identifier representing a specific user.

example: 9

username (optional)

String User name of the user.

example: jdoe

domain (optional)

String ActiveDirectory(LDAP) domain

firstName (optional)

String First name of the user.

example: John

lastName (optional)

String Last name of the user.

example: Doe

principalId (optional)

String

example: 9

email (optional)

String Email id of the user.

example: a@a.com

emailVerified (optional)

Boolean Confirms email verification

example: true

passwordSet (optional)

Boolean

example: true

questionsSet (optional)

Boolean

example: true

enableAutoLogin (optional)

Boolean

example: true

licenseFeatures (optional)

array[LicenseFeature] License assigned to the user.

roles (optional)

array[RoleBasicV2] Roles assigned to the user.

multipleLoginAllowed (optional)

Boolean Mutliple login status

example: false

deleted (optional)

Boolean

example: false

Automation 360

Authentication API (V2)