Generate Token

URL:
https://<admin-root>/generateToken
Methods:
GET
Required Capability:
Administrator
Version Introduced:
10.8

Description

Generates a token. The generated security token can be used by clients when working with the Administrator API.

Request Parameters

ParameterDescription

username

The name of an administrative account for the site.

Example

Use dark colors for code blocksCopy
1
username=user1

password

The credentials of the administrative account.

Example

Use dark colors for code blocksCopy
1
password=testpassword

client

The client IP or HTTPS Referer to which the generated token will be bound.

Values: referer | ip | requestip

referer

The base URL of the web application that will invoke the Administrator API. This parameter must be specified if the value of client parameter is referer.

Example

Use dark colors for code blocksCopy
1
referer=https://myserver/mywebapp

ip

(Optional, required if client is set to ip ).

The IP address of the machine that will invoke the Administrator API.

Example

Use dark colors for code blocksCopy
1
##.##.###.###

expiration

The time in minutes for which the token must be valid.

Example

Use dark colors for code blocksCopy
1
expiration=90

f

The response format. The default response format is html .

Values: html | json

Example usage

Below is a sample POST request for generateToken :

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /webadaptor/admin/generateToken HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

username=user1&password=testpassword&client=referer&referer=https://machine.domain.com&expiration=90&f=json

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
4
{
  "token":"<token>",
  "expires": "<date>"
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
{
  "token": "sakjfh97325437hskfsdfd_sdkjfsjf1283763339564921734sdfbdsj",
  "expires": "13472658353687"
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.