GetJWT - JWT Tokens - Data8 Web Services API Documentation

GetJWT

Get a JWT token to authenticate requests to our services

Description

This method generates a JWT token with an expiry date and credit limit. The names of services can also be passed to the method for further restriction.

Endpoint URLs

To connect to this service you'll need to use one of these endpoints:

Protocol	URL
JSON	JSON https://webservices.data-8.co.uk/UserAdmin/GetJWT.json
OPEN API	OPEN API https://webservices.data-8.co.uk/swagger/UserAdmin/swagger.json
SOAP	SOAP https://webservices.data-8.co.uk/useradmin.asmx
MCP	MCP https://webservices.data-8.co.uk/mcp/useradmin (tool name `get_j_w_t`)

Parameters

The following parameters can be supplied to this method:

Name	Description
username	username See the available authentication methods. If you are using username & password authentication, specify the username to authenticate as. If you are using API Key authentication and you are not using the JSON, Javascript or ADO APIs, use your API Key here with the prefix `apikey-`, e.g. `apikey-ABCD-1234-EFGH-5678`
password	password If you are using username & password authentication, specify the password to use for authentication. Otherwise leave this blank.
clientIp	clientIp The IP address of the client. This can be blank to allow requests from any IP address
expiresAt	expiresAt A DateTime at which the JWT Token will expire. This should be in the UTC time zone.
allowedMethods	allowedMethods A string array of service names, or a service name combined with a method name with a period.
maxCredits	maxCredits An optional parameter containing a limit for the number of credits the token can use.
options	options An array of options that control further details of how this method operates. See the `Advanced Options` section below, for more information.

Advanced Options

The following options can be specified as part of the option parameter. Each option is specified as a key/value pair. The list of available names is shown below, along with a description of the allowable values for that name.

Name	Description
Common Options
ApplicationName	ApplicationName Gives the name of the calling application - used to break down usage by application in the usage reports on the dashboard.

Results

This method returns an object containing the following fields:

Name Description

Status

Name	Description
Status	Status Indicates whether the method call was successful, or if some error occurred. If the `Success` field is `true`, the other results described below can be used to get the results of the method. If `Success` is `false`, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the `ErrorMessage` field, and any other results should be ignored.
Jwt	Jwt The Token string generated from the request

Indicates whether the method call was successful, or if some error occurred. If the Success field is true, the other results described below can be used to get the results of the method. If Success is false, some error occurred in calling the method, such as the authentication failed or the account is out of credits. The details of the error can be obtained from the ErrorMessage field, and any other results should be ignored.

Jwt

The Token string generated from the request

Credit Usage

Requests to this method do not consume credits, but you must have some UserAdmin credits available.

Sample Code

Request Format

{
  "clientIp": "",
  "expiresAt": "2020-06-01T01:00:00",
  "allowedMethods": [
    "EmailValidation",
    "InternationalTelephoneValidation.IsValid"
  ],
  "maxCredits": 5,
  "options": {}
}

Response Format

{}

Depending on your chosen authentication method you will need to modify this request slightly:

API Key

Post the request to
https://webservices.data-8.co.uk/UserAdmin/GetJWT.json?key=your-api-key
and do NOT include the username or password properties in the request JSON document.

Parameter	Value
Parameters
request
Credits Remaining Today: 5 Try It Now!