Authentication API

Use the Authentication API to generate, validate, 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 - 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 ServiceUserAuthRequest (required)

Body Parameter —

Return type

ServiceUserAuthResponse

Example data

Content-Type: application/json

{
  "jwtPkPem" : "jwtPkPem",
  "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 ServiceUserAuthResponse

400

Bad Request 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

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

Models

Methods

Table of Contents

Error
ServiceUserAuthRequest
ServiceUserAuthResponse

`Error` Up

code (optional)

String Error code

message (optional)

String Message describing error

details (optional)

String More details of the error message

`ServiceUserAuthRequest` Up

username (optional)

String App username

example: serviceuser

password (optional)

String App password

example: mypassword@123

`ServiceUserAuthResponse` Up

token (optional)

String JWT token

example: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZS

jwtPkPem (optional)

String JWT private key to validate tokens, including this one

Automation 360

Authentication API