Method CreateApiToken
CreateApiToken(String, ApiTokenOptionsContract)
Create API token.
Declaration
string CreateApiToken(string connectionId, ApiTokenOptionsContract options)
Parameters
Type | Name | Description |
---|---|---|
System.String | connectionId | The connection id to identify your connection. See also ConnectionId |
ApiTokenOptionsContract | options | The api token options. |
Returns
Type | Description |
---|---|
System.String | The JWT token for this connection. |
Remarks
- Enter "ExpirationDate" in UTC-Format.
Examples
POST https://YourServerName/InfoShare/Json/Authentication/CreateApiToken
Example for a create api token.{
"connectionId": "6bc655a4-c079-4535-a733-f259e3232a3a",
"options": {
"TokenName": "TokenName",
"ExpirationDate": "2019-09-26T22:00:00",
"WithConnenctionId": "true",
"RoleNames": ["Administration"]
"Scope": {
"LoginAsUser": true }
}
Response:
{
"CreateApiTokenResult": "eyJhbGciOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzA0L3htbGRzaWctbW9yZSNobWFjLXNoYTI1NiIsInR5cCI6IkpXVCJ9.eyJuYmYiOjE2MjU2NDQ4MjIsImV4cCI6MTYyNTYzNzAwMCwiaWF0IjoxNjI1NjQ0ODIyLCJ0b2tlbklkIjoiMWIwZjhkMWItNGQxNy00YzAxLTgwMzQtNmE2MGE1ZDYyZDkzIiwidXNlcm5hbWUiOiJkY2lhZG1pbiIsInVzZXJJZCI6IjAxMDBhMDAzLTM4YTctMTFkOC1hOTAyLTAwNTBiZjQyN2U4ZiIsImNyZWF0ZURhdGUiOiIyMDIxLTA3LTA3VDEwOjAwOjIyIiwiZXhwaXJhdGlvbkRhdGUiOiIyMDIxLTA3LTA3VDA3OjUwOjAwIiwiY29ubmVjdGlvbklkIjoiNDU1ZTdhY2YtNzAwNi00YzJkLWFkYzktMDNjOTdiMzA2NzBkIiwidG9rZW5OYW1lIjoiVGVzdCIsInRva2VuVHlwZSI6ImFwaXRva2VuIn0.v0s7XKlttJe9kiqM24K37Cim16x6V0THv2_Ww_Ctv5k"
}
Exceptions
Type | Condition |
---|---|
ServiceException | The connection id {connectionId} isn't valid or has expired (10008) |