Client

This documentation is currently outdated and in the process of being updated. This documentation is provided as a temporary reference to various API endpoints and output. This warning will be at the top of each outdated page. As the documentation is updated, this warning will be removed.

Knowing your client ID is pivotal in using APIs. Each client in Ivanti Neurons for RBVM/ASOC has its own unique client ID. You need this ID to run the majority of the API requests. Your client ID tells the platform what client to make the requested changes to. You can also view your client ID when Viewing Your User Profile.

Finding Your Client ID

Find your client ID for use in other API functions.

API Call: GET/client

URL: https://platform<PLATFORM>.risksense.com/api/vi/client

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure

Required Privileges

The privileges required to find your client ID are:

-

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
PAGESIZE Page size requested. integer Y Shows how many items to display on the page.
PAGENUMBER Page to view. integer Y First Page: 0

cURL

cURL Sample get_clientid Snippet

Copy 
curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client?size=<PAGESIZE>&page=<PAGENUMBER>" \
  -H  "accept: application/json" \
  -H  "x-api-key: <APIKEY>" \

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
PAGESIZE Page size requested. integer Y Shows how many items to display on the page.
PAGENUMBER Page to view. integer Y First Page: 0
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Copy 

{
  "page": {
    "size": <PAGESIZE>,
    "totalElements": <TOTALELEMENTS>,
    "totalPages": <TOTALPAGES>,
    "number": <PAGENUMBER>
  },
  "_embedded": {
    "clients": [
      {
        "id": <ID>,
        "uuid": "<UUID>",
        "name": "<NAME>",
        "rs3": <RS3>,
        "contact": {
          "address": "<ADDRESS1>",
          "address2": "<ADDRESS2>",
          "city": "<CITY>",
          "state": "<STATE>",
          "zip": <ZIP>,
          "phone": "<PHONE>"
        },
        "expirationDate": "<EXPIRATIONDATE>",
        "notes": "<NOTES>",
        "description": "<DESCRIPTION>",
        "industry": "<INDUSTRY>",
        "disabled": <DISABLED>,
        "demoClient": <DEMOCLIENT>,
        "accountManagerId": <ACCOUNTMANAGERID>
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://platform.risksense.com/api/v1/client?page=<PAGENUMBER>&size=<PAGESIZE>"
    }
  }
}
Name Description Type Additional Information
PAGESIZE Page size requested. integer Shows how many items to display on the page.
TOTALELEMENTS Total number of items available. integer
TOTALPAGES Total number of pages available. integer
PAGENUMBER Page to view. integer First Page: 0
ID Client ID number. integer Finding Your Client ID
UUID Client Universal Unique Identifier. string
NAME Client name. string
RS3 Client RiskSense Security Score. number($double)
ADDRESS1 Client address first line. string
ADDRESS2 Client Address second line. string
CITY Client city. string
STATE Client state. string
ZIP Client zip code. string Pattern: \d{5}
PHONE Client phone number. string($phone)
EXPIRATIONDATE Client platform subscription expiration date. string($date)
NOTES Notes about the client. string
DESCRIPTION Client description. string
INDUSTRY Client's industry. string Options: General, Education, Energy/Utility, Entertainment, Finance, Gaming, Government, Healthcare, Retail
DISABLED Is the client's platform access disabled? boolean True = Yes, False = No
DEMOCLIENT Is the client a demo client? boolean True = Yes, False = No
ACCOUNTMANAGERID Account manager ID number. number Used internally by RiskSense.

HTTP Status Codes

Code Description
200 Success

200 Sample Response

Copy 

{
  "page": {
    "size": 15,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  },
  "_embedded": {
    "clients": [
      {
        "id": 12,
        "uuid": "123e4567-e89b-12d3-a456-556642441234",
        "name": "sample client",
        "rs3": 432,
        "contact": {
          "address": "4200 Osuna Rd NE",
          "address2": "Suite 300",
          "city": "Albuquerque",
          "state": "NM",
          "zip": 87113,
          "phone": "505-234-7654"
        },
        "expirationDate": "2018-02-26",
        "notes": "some notes",
        "description": "some text",
        "industry": "General",
        "disabled": false,
        "demoClient": true,
        "accountManagerId": 2
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://platform.risksense.com/api/v1/client?page=0&size=15"
    }
  }
}

Code Description
401 Unauthorized

Viewing Client Details

View detailed information about a specific client.

API Call: GET/client/{clientId}

URL: https://platform<PLATFORM>.risksense.com/api/vi/client/<CLIENTID>

URL Parameters

Name Description Additional Information
PLATFORM Platform number. Endpoint URL Structure
CLIENTID Client ID number. Finding Your Client ID

Required Privileges

The privileges required to find your client ID are:

-

API Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
APIKEY Your API key. string Y Generating an API Token
CLIENTID Client ID number. integer Y Finding Your Client ID

cURL

cURL Sample client_details Snippet

Copy 
curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>" \
  -H  "accept: application/json" \
  -H  "x-api-key: <APIKEY>" \

Replace angle bracket parameters with your own values.

cURL Parameters

Name Description Type Required Additional Information
PLATFORM Platform number. integer Y Endpoint URL Structure
CLIENTID Client ID number. integer Y Finding Your Client ID
APIKEY Your API key. string Y Generating an API Token

Response Parameters

Sample Response

Copy 
{
  "id": <ID>,
  "uuid": "<UUID>",
  "name": "<NAME>",
  "rs3": <RS3>,
  "contact": {
    "address": "<ADDRESS1>",
    "address2": "<ADDRESS2>",
    "city": "<CITY>",
    "state": "<STATE>",
    "zip": <ZIP>,
    "phone": "<PHONE>"
  },
  "expirationDate": "<EXPIRATIONDATE>",
  "notes": "<NOTES>",
  "description": "<DESCRIPTION>",
  "industry": "<INDUSTRY>",
  "disabled": <DISABLED>,
  "demoClient": <DEMOCLIENT>,
  "accountManagerId": <ACCOUNTMANAGERID>
}
Name Description Type Additional Information
ID Client ID number. integer
UUID Client Universal Unique Identifier. string
NAME Client name. string
RS3 Client RiskSense Security Score. number($double)
ADDRESS1 Client address first line. string
ADDRESS2 Client Address second line. string
CITY Client city. string
STATE Client state. string
ZIP Client zip code. string Pattern: \d{5}
PHONE Client phone number. string($phone)
EXPIRATIONDATE Client platform subscription expiration date. string($date)
NOTES Notes about the client. string
DESCRIPTION Client description. string
INDUSTRY Client's industry. string Options: General, Education, Energy/Utility, Entertainment, Finance, Gaming, Government, Healthcare, Retail
DISABLED Is the client's platform access disabled? boolean True = Yes, False = No
DEMOCLIENT Is the client a demo client? boolean True = Yes, False = No
ACCOUNTMANAGERID Account manager ID number. number Used internally by Ivanti.

HTTP Status Codes

Code Description
200 Success

201 Sample Response

Copy 
{
  "id": 12,
  "uuid": "123e4567-e89b-12d3-a456-556642441234",
  "name": "sample client",
  "rs3": 432,
  "contact": {
    "address": "4200 Osuna Rd NE",
    "address2": "Suite 300",
    "city": "Albuquerque",
    "state": "NM",
    "zip": 87113,
    "phone": "505-234-7654"
  },
  "expirationDate": "2018-02-26",
  "notes": "some notes",
  "description": "some text",
  "industry": "General",
  "disabled": false,
  "demoClient": true,
  "accountManagerId": 2
}
Code Description
401 Unauthorized