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. Default time out can be configured by an admin in Administration > Security Settings > Time-out session settings. For more information, see Settings.
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 - 1.0.0

All rights reserved

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

Access

Methods

Models

Table of Contents

Auth

Up

post /authentication/app/login

Authenticate app User (authenticationAppLoginPost)

This endpoint is a service to service authentication API used by Automation Anywhere internally supported applications. This API is not supported for use by external users.

Consumes

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

*/*

Request body

body AuthRequest (required)

Body Parameter —

Return type

AuthResponse

Example data

Content-Type: application/json

{
  "tenantUuid" : "tenantUuid",
  "user" : {
    "lastName" : "Doe",
    "roles" : [ {
      "name" : "name",
      "id" : 0.8008281904610115
    }, {
      "name" : "name",
      "id" : 0.8008281904610115
    } ],
    "principalId" : 1.4658129805029452,
    "passwordSet" : true,
    "licenseFeatures" : [ "DEVELOPMENT", "DEVELOPMENT" ],
    "emailVerified" : true,
    "firstName" : "John",
    "enableAutoLogin" : true,
    "permissions" : [ {
      "resourceId" : "resourceId",
      "action" : "action",
      "id" : 6.027456183070403,
      "resourceType" : "resourceType"
    }, {
      "resourceId" : "resourceId",
      "action" : "action",
      "id" : 6.027456183070403,
      "resourceType" : "resourceType"
    } ],
    "domain" : "domain",
    "id" : 9.0,
    "passwordExpired" : true,
    "locked" : true,
    "email" : "a@a.com",
    "username" : "jdoe"
  },
  "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

Auth object containing token generated for specific user AuthResponse

400

Bad Rquest Error

401

Authentication required Error

500

Internal Server error Error

Up

post /authentication/logout

Logout a user and delete the JWT (Java Web token) (authenticationLogoutPost)

<p>This endpoint immediately invalidates an access token so that it cannot be used for authentication. The token to be logged out is passed in a header file with the request.</p> <blockquote> <blockquote> <p><strong>Header file example:</strong> <code>-H X-Authorization <token></code> or <code>Authorization: Bearer <<bearer token>></code></p> </blockquote> </blockquote>

Request headers

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

204

Successful Logout

500

Internal Server error Error

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:

*/*

Request body

body AuthRequest (required)

Body Parameter —

Return type

AuthResponse

Example data

Content-Type: application/json

{
  "tenantUuid" : "tenantUuid",
  "user" : {
    "lastName" : "Doe",
    "roles" : [ {
      "name" : "name",
      "id" : 0.8008281904610115
    }, {
      "name" : "name",
      "id" : 0.8008281904610115
    } ],
    "principalId" : 1.4658129805029452,
    "passwordSet" : true,
    "licenseFeatures" : [ "DEVELOPMENT", "DEVELOPMENT" ],
    "emailVerified" : true,
    "firstName" : "John",
    "enableAutoLogin" : true,
    "permissions" : [ {
      "resourceId" : "resourceId",
      "action" : "action",
      "id" : 6.027456183070403,
      "resourceType" : "resourceType"
    }, {
      "resourceId" : "resourceId",
      "action" : "action",
      "id" : 6.027456183070403,
      "resourceType" : "resourceType"
    } ],
    "domain" : "domain",
    "id" : 9.0,
    "passwordExpired" : true,
    "locked" : true,
    "email" : "a@a.com",
    "username" : "jdoe"
  },
  "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. AuthResponse

400

Bad Rquest Error

401

Authentication required Error

500

Internal Server error Error

Up

get /authentication/token

Verify if a token is valid (authenticationTokenGet)

<p>Use this endpoint to validate an existing JWT. The token is included in the request URL. There is no request body for this endpoint. The response is either <code>"valid": true</code>(the token is valid) or <code>"valid": false</code>(the token is not valid).</p> <p>The query parameter <strong>token</strong> is deprecated and will be removed in future releases. It is deprecated as providing a token in a query param gets the token logged in the logs. Instead pass the token through <strong>X-Authorization</strong> in the request header.</p>

Request headers

Query parameters

token (optional)

Query Parameter — token

Return type

Object

Example data

Content-Type: application/json

{
  "valid" : true
}

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

A successful response can be either true or false. Object

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 experation 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>

Consumes

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

*/*

Request body

body RefreshAuthRequest (required)

Body Parameter —

Return type

AuthResponse

Example data

Content-Type: application/json

{
  "tenantUuid" : "tenantUuid",
  "user" : {
    "lastName" : "Doe",
    "roles" : [ {
      "name" : "name",
      "id" : 0.8008281904610115
    }, {
      "name" : "name",
      "id" : 0.8008281904610115
    } ],
    "principalId" : 1.4658129805029452,
    "passwordSet" : true,
    "licenseFeatures" : [ "DEVELOPMENT", "DEVELOPMENT" ],
    "emailVerified" : true,
    "firstName" : "John",
    "enableAutoLogin" : true,
    "permissions" : [ {
      "resourceId" : "resourceId",
      "action" : "action",
      "id" : 6.027456183070403,
      "resourceType" : "resourceType"
    }, {
      "resourceId" : "resourceId",
      "action" : "action",
      "id" : 6.027456183070403,
      "resourceType" : "resourceType"
    } ],
    "domain" : "domain",
    "id" : 9.0,
    "passwordExpired" : true,
    "locked" : true,
    "email" : "a@a.com",
    "username" : "jdoe"
  },
  "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. AuthResponse

400

Bad Rquest Error

401

Authentication required Error

500

Internal Server error Error

Models

Methods

Table of Contents

AuthRequest
AuthResponse
Error
LicenseFeature
PermissionDto
RefreshAuthRequest
RoleDto
UserDetails

`AuthRequest` Up

username (optional)

String username of non-AD User

example: jdoe

password (optional)

String Password of non-AD User. 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

multiLogin (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>.