DeepLink API Calls
Create OIDC Client
This call creates ClientID and secret for a given account Guid.
Authentication
This call requires Tenant Admin credentials or user having system management or user management role.
HTTP Method
POST
Request URI
api/v1/oidc/client
Request Parameters
|
Parameter |
Argument Type |
Description |
Example Value |
|---|---|---|---|
| accountGuid | Request Body | Account Guid of the client. | 1181cdec-f141-4de3-b71a-36fc26ab9a4a |
This API can be accessed with Basic mode of authentication as well as with the Token-based authentication.
Example Request with Access Token
curl --location --request GET 'https://[Ivanti Neurons for MDM]/api/v1/ec' \
--header 'Authorization: Basic <token>' \
Example Request with Basic Auth
curl --location --request GET 'https://[Ivanti Neurons for MDM]/api/v1/ec' \
--header 'Authorization: Basic <token>' \
Sample Response
{
"errors": null,
"result": {
"searchResults": [
{
"id": 28723,
"createdAt": 1591726945738,
"createdBy": 67076,
"modifiedAt": 1591748936099,
"modifiedBy": 1,
"name": "ppp091.auto.mobileiron.com",
"description": null,
"registrationState": "REGISTERED",
"kocabVersion": "69.0.0.24",
"enabled": true,
"routingTagIds": [],
"lastConnectedAt": 1591741596537,
"available": false,
"capabilities": {
"caServers": [
{
"displayName": "Generic SCEP Server",
"displayNameKey": "ca.connector.generic.name",
"configOptions": [
{
"key": "scep.url",
"defaultValue": null,
"description": "SCEP URL",
"descriptionKey": "ca.connector.common.option.scep.url",
"required": true,
"valueType": "URL"
},
{
"key": "scep.static.challenge",
"defaultValue": null,
"description": "Static Challenge Password",
"descriptionKey": "ca.connector.common.option.static.challenge",
"required": false,
"valueType": "STRING"
},
{
"key": "scep.ca.identifier",
"defaultValue": null,
"description": "CA Identifier",
"descriptionKey": "ca.connector.common.option.ca.identifier",
"required": false,
"valueType": "STRING"
}
],
"serverType": "OTHER"
},
{
"displayName": "Microsoft NDES",
"displayNameKey": "ca.connector.microsoft.ndes.name",
"configOptions": [
{
"key": "scep.url",
"defaultValue": null,
"description": "SCEP URL",
"descriptionKey": "ca.connector.common.option.scep.url",
"required": true,
"valueType": "URL"
},
{
"key": "microsoft.ndes.username",
"defaultValue": null,
"description": "Admin Username",
"descriptionKey": "ca.connector.microsoft.ndes.option.username",
"required": false,
"valueType": "STRING"
},
{
"key": "microsoft.ndes.password",
"defaultValue": null,
"description": "Admin Password",
"descriptionKey": "ca.connector.microsoft.ndes.option.password",
"required": false,
"valueType": "PASSWORD"
},
{
"key": "microsoft.ndes.challenge.url",
"defaultValue": null,
"description": "Challenge URL",
"descriptionKey": "ca.connector.microsoft.ndes.option.challengeUrl",
"required": false,
"valueType": "URL"
}
],
"serverType": "MICROSOFT"
},
{
"displayName": "EJBCA Server",
"displayNameKey": "ca.connector.ejbca.name",
"configOptions": [
{
"key": "scep.url",
"defaultValue": null,
"description": "SCEP URL",
"descriptionKey": "ca.connector.common.option.scep.url",
"required": true,
"valueType": "URL"
},
{
"key": "scep.static.challenge",
"defaultValue": null,
"description": "Static Challenge Password",
"descriptionKey": "ca.connector.common.option.static.challenge",
"required": false,
"valueType": "STRING"
},
{
"key": "scep.ca.identifier",
"defaultValue": null,
"description": "CA Identifier",
"descriptionKey": "ca.connector.common.option.ca.identifier",
"required": false,
"valueType": "STRING"
}
],
"serverType": "EJBCA"
}
]
},
"unicastRoutingTagId": 29697,
"loggingLevel": "INFO",
"loggingRevertsAt": null
}
],
"totalCount": 1,
"offset": 0,
"limit": 50
}
}
DeepLink Login
This API fetches the one time login nonce token.
Authentication
This call requires tenant admin credentials.
HTTP Method
GET
Request URI
api/v1/ec
Request Parameters
|
Parameter |
Argument Type |
Description |
Example Value |
|---|---|---|---|
| N/A |
Example Request with Access Token
curl --location --request GET 'https://[Ivanti Neurons for MDM]/api/v1/ec' \
--header 'Authorization: Basic <token>' \
Example Request with Basic Auth
Response
{
"errors": null,
"result": {
"searchResults": [
{
"id": 28723,
"createdAt": 1591726945738,
"createdBy": 67076,
"modifiedAt": 1591748936099,
"modifiedBy": 1,
"name": "ppp091.auto.mobileiron.com",
"description": null,
"registrationState": "REGISTERED",
"kocabVersion": "69.0.0.24",
"enabled": true,
"routingTagIds": [],
"lastConnectedAt": 1591741596537,
"available": false,
"capabilities": {
"caServers": [
{
"displayName": "Generic SCEP Server",
"displayNameKey": "ca.connector.generic.name",
"configOptions": [
{
"key": "scep.url",
"defaultValue": null,
"description": "SCEP URL",
"descriptionKey": "ca.connector.common.option.scep.url",
"required": true,
"valueType": "URL"
},
{
"key": "scep.static.challenge",
"defaultValue": null,
"description": "Static Challenge Password",
"descriptionKey": "ca.connector.common.option.static.challenge",
"required": false,
"valueType": "STRING"
},
{
"key": "scep.ca.identifier",
"defaultValue": null,
"description": "CA Identifier",
"descriptionKey": "ca.connector.common.option.ca.identifier",
"required": false,
"valueType": "STRING"
}
],
"serverType": "OTHER"
},
{
"displayName": "Microsoft NDES",
"displayNameKey": "ca.connector.microsoft.ndes.name",
"configOptions": [
{
"key": "scep.url",
"defaultValue": null,
"description": "SCEP URL",
"descriptionKey": "ca.connector.common.option.scep.url",
"required": true,
"valueType": "URL"
},
{
"key": "microsoft.ndes.username",
"defaultValue": null,
"description": "Admin Username",
"descriptionKey": "ca.connector.microsoft.ndes.option.username",
"required": false,
"valueType": "STRING"
},
{
"key": "microsoft.ndes.password",
"defaultValue": null,
"description": "Admin Password",
"descriptionKey": "ca.connector.microsoft.ndes.option.password",
"required": false,
"valueType": "PASSWORD"
},
{
"key": "microsoft.ndes.challenge.url",
"defaultValue": null,
"description": "Challenge URL",
"descriptionKey": "ca.connector.microsoft.ndes.option.challengeUrl",
"required": false,
"valueType": "URL"
}
],
"serverType": "MICROSOFT"
},
{
"displayName": "EJBCA Server",
"displayNameKey": "ca.connector.ejbca.name",
"configOptions": [
{
"key": "scep.url",
"defaultValue": null,
"description": "SCEP URL",
"descriptionKey": "ca.connector.common.option.scep.url",
"required": true,
"valueType": "URL"
},
{
"key": "scep.static.challenge",
"defaultValue": null,
"description": "Static Challenge Password",
"descriptionKey": "ca.connector.common.option.static.challenge",
"required": false,
"valueType": "STRING"
},
{
"key": "scep.ca.identifier",
"defaultValue": null,
"description": "CA Identifier",
"descriptionKey": "ca.connector.common.option.ca.identifier",
"required": false,
"valueType": "STRING"
}
],
"serverType": "EJBCA"
}
]
},
"unicastRoutingTagId": 29697,
"loggingLevel": "INFO",
"loggingRevertsAt": null
}
],
"totalCount": 1,
"offset": 0,
"limit": 50
}
}
Reset Secret
This call creates ClientID and secret for a given account Guid.
Authentication
This call requires Tenant Admin credentials or user having system management or user management role.
HTTP Method
POST
Request URI
api/v1/oidc/client
Request Parameters
|
Parameter |
Argument Type |
Description |
Example Value |
|---|---|---|---|
| accountGuid | Request Body | Account Guid of the client. | 1181cdec-f141-4de3-b71a-36fc26ab9a4a |
This API can be accessed with Basic mode of authentication as well as with the Token-based authentication.
Example Request
curl --location --request GET 'https://[Ivanti Neurons for MDM]/api/v1/ec' \
--header 'Authorization: Basic <token>' \
Sample Response
{"errors":null,
"result":{
"clientId":"CLIENT_ID ",
"clientSecret":"CLIENT_SECRET",
"accountGuid":"1181cdec-f141-4de3-b71a-36fc26ab9a4a"
}
}