authentication
The authentication enables you to retrieve the JWT access token and the expiration time.
In the screen shot below, the request URI and the body values are taken from the App Registration.
Header Parameters
Unless stated, these parameters are mandatory.
Name | Type | Description |
---|---|---|
Authorization |
Bearer |
Contains Ivanti Neurons JWT bearer token issued by login app. |
X-Landscape-Url |
String |
Directs the request to the specified landscape (only used by RapidApi) |
X-ClientScope |
String |
The scope (assigned role) of the authentication request. If left empty, default read-only permissions are applied. (Optional) |
X-ClientSecret |
String |
The client secret used during app registration. |
X-TenantId |
String |
The registered tenant ID. |
X-ClientId |
String |
The requesting client ID. |
X-RapidAPI-Key |
Enum |
The key that applications and developers need to invoke the API. |
X-RapidAPI-Host |
String |
The name that identifies which API will be used. For example: my-api-name.ivanti.rapidapi.com. |
Output Data Properties
The following set of data items represent an authentication result that will be returned as part of a successful authentication_get response.
Name |
Type |
Format |
Description |
---|---|---|---|
access_token | String | The JWT access token. | |
expires_in | Integer | Int32 | The expiration time, in seconds. |
scope |
String |
|
The assigned scope (role) of the authentication token. |
token_type | String | The type of token. The default is Bearer. |