URL:
https://<root>/generateToken
Methods:
POST
Required Capability:
Administrator
Version Introduced:
12.2

Description

The generateToken operation generates an ArcGIS token that can be used by clients when working with the ArcGIS Data Pipelines Server Administrator API.

Request parameters

ParameterDetails

username

The case-sensitive username of the user who wants to get a token.

Example
Use dark colors for code blocksCopy
1
username=user123

password

The password of the user who wants to get a token.

Example
Use dark colors for code blocksCopy
1
password=secret123

client

The client identification type for which the token is to be generated. Users can specify whether the token will be generated for a client application's base URL, a user-specified IP address, or the IP address that is making the request.

Values: referer | ip | requestip

referer

The base URL of the web app that will invoke the request to access a secured resource. This parameter must be specified if the value of the client parameter is referer.

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

ip

The IP address of the machine that will invoke the request to access a secured resource. This parameter must be specified if the value of the client parameter is ip .

Example
Use dark colors for code blocksCopy
1
ip=###.###.###.###

expiration

The token expiration time in minutes. The default is 60 minutes (one hour). Applications are responsible for renewing expired tokens; expired tokens will be rejected by the server on subsequent requests that use the token.

Example
Use dark colors for code blocksCopy
1
expiration=60

f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

The following is a sample POST request for the generateToken operation:

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

username=user1&password=testpassword&client=referer&referer=https://organization.example.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.