User
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.
The Ivanti Neurons for RBVM/ASOC platform is a role-based system, meaning users are assigned to specific roles that control access to the Ivanti Neurons for RBVM/ASOC platform user interface and the operations they can perform, from uploading vulnerability and asset information, to remediating vulnerabilities. In addition to roles, Ivanti Neurons for RBVM/ASOC groups provide a way to organize the asset and application data stored and maintained by the platform, so that data is assigned to groups and only users who are members of those same groups may access the data.
Viewing Your User Profile
View your user profile and obtain your client ID.
API Call: GET/user/profile
URL: https://platform<PLATFORM>.risksense.com/api/v1/user/profile
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
User Roles
The user roles that can view their user profile are:
- Group Manager
- Manager
- User
- Technician
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 |
cURL
cURL Sample view_user Snippet
curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/user/profile"
-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 |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
Response Parameters
Sample Response
{
"userId": <USERID>,
"firstName": "<FIRSTNAME>",
"lastName": "<LASTNAME>",
"userName": "<USERNAME>",
"clientId": <CLIENTID>,
"clientName": "<CLIENTNAME>",
"isInternalClient": <INTERNALCLIENT>,
"role": "<ROLE>",
"multiClientUser": <MULTICLIENTUSER>,
"uploadEnabled": <UPLOADENABLED>,
"readOnly": <READONLY>
}
Name | Description | Type | Additional Information |
---|---|---|---|
USERID | User ID number. | integer
|
|
FIRSTNAME | User's first name. | string
|
|
LASTNAME | User's last name. | string
|
|
USERNAME | User's platform username. | string
|
|
CLIENTID | Client ID number. | integer
|
|
INTERNALCLIENT | Is this an internal client? | boolean
|
Options: True = Yes, False = No |
ROLE | User's role | string
|
|
MULTICLIENTUSER | Is this a multi-client user? | boolean
|
Options: True = Yes, False = No |
UPLOADENABLED | Provides group managers the ability to upload scan files. | boolean
|
Options: True = Yes, False = No |
READONLY | Is this user read only? | boolean
|
Options: True = Yes, False = No |
HTTP Status Codes
Code | Description |
---|---|
200 | Success |
401 | Unauthorized |
Changing User Token Usage Permissions
Change if a user can use tokens.
API Call: POST/user/{userId}/tokenAllowed
URL: https://platform<PLATFORM>.risksense.com/api/v1/user/<USERID>/tokenAllowed
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
User Roles
The user role that can change if a user can use tokens is:
- Manager
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 |
USERID | User ID number. | integer
|
Y | Searching for Users |
ALLOWED | Allow token use? | boolean
|
Y | Options: True = Yes, False = No |
cURL
cURL Sample user_tokenPermissions Snippet
curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/user/<USERID>/tokenAllowed"
-H "accept: application/json"
-H "x-api-key: <APIKEY>"
-H "Content-Type: application/json"
-d "{ \"allowed\": <ALLOWED>}"
Replace angle bracket parameters with your own values.
cURL Parameters
Name | Description | Type | Required | Additional Information |
---|---|---|---|---|
PLATFORM | Platform number. | integer
|
Y | Endpoint URL Structure |
USERID | User ID number. | integer
|
Y | Searching for Users |
APIKEY | Your API key. | string
|
Y | Generating an API Token |
ALLOWED | Allow token use? | boolean
|
Y | Options: True = Yes, False = No |
HTTP Status Codes
Code | Description |
---|---|
204 | Success |
400 | Bad Request |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
Initiating a User Export Job
Initiate user export job.
API Call: POST/client/{clientId}/user/export
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/export
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
User Roles
The user roles that can initiate a user export job are:
- Group Manager
- Manager
- User
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 |
FILENAME | Exported file's name. | string
|
Y | |
FIELD | Filter category. | string
|
Y | |
EXCLUSIVE | Exclusive. | boolean
|
Y | Options: True = Exclude values listed in the VALUE field, False = Filter based on VALUE field. |
OPERATOR | Search operator. | string
|
Y | Options: EXACT, IN, LIKE, WILDCARD, RANGE, CIDR |
VALUE | Search value. | string
|
Y | |
FILETYPE | File type. | string
|
Y | Options: XML, XLSX, CSV |
COMMENT | Comment. | string
|
Y |
cURL
cURL Sample user_export Snippet
curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/export"
-H "accept: application/json"
-H "x-api-key: <APIKEY>"
-H "Content-Type: application/json"
-d "{ \"filterRequest\": { \"filters\": [ { \"field\": \"<FIELD>\", \"exclusive\": <EXCLUSIVE>, \"operator\": \"<OPERATOR>\", \"value\": \"<VALUE>\" } ] }, \"fileType\": \"<FILETYPE>\", \"comment\": \"<COMMENT>\", \"fileName\": \"<FILENAME>\"}"
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 |
FIELD | Filter category. | string
|
Y | |
EXCLUSIVE | Exclusive. | boolean
|
Y | Options: True = Exclude values listed in the VALUE field, False = Filter based on VALUE field. |
OPERATOR | Search operator. | string
|
Y | Options: EXACT, IN, LIKE, WILDCARD, RANGE, CIDR |
VALUE | Search value. | string
|
Y | |
FILETYPE | File type. | string
|
Y | Options: XML, XLSX, CSV |
COMMENT | Comment. | string
|
Y | |
FILENAME | Exported file's name. | string
|
Y |
Response Parameters
Sample Response
{
"id": <ID>,
"created": "<CREATED>"
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | User Export Job ID number. | integer
|
|
CREATED | Date/time job created. | string($date-time)
|
HTTP Status Codes
Code | Description |
---|---|
200 | Success |
200 Sample Response
{
"id": 0,
"created": "2019-09-17T16:59:16.922Z"
}
Code | Description |
---|---|
400 | Bad Request |
401 | Unauthorized |
404 | Not Found |
Listing User Projections and Their Models
List user projections and their models that can be requested from the search endpoint.
API Call: GET/client/{clientId}/user/model
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/model
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
User Roles
The user roles that can list user projections and their models are:
- Manager
- Group Manager
- User
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 user_projections Snippet
curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/model"
-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
{
"subject": "user",
"projections": [
{
"name": "basic",
"fields": [
{
"field": "id",
"type": "int",
"nested": []
},
{
"field": "uuid",
"type": "UUID",
"nested": []
},
{
"field": "clientId",
"type": "int",
"nested": []
},
{
"field": "firstName",
"type": "string",
"nested": []
},
{
"field": "lastName",
"type": "string",
"nested": []
},
{
"field": "username",
"type": "string",
"nested": []
},
{
"field": "email",
"type": "string",
"nested": []
},
{
"field": "phoneNumber",
"type": "string",
"nested": []
},
{
"field": "multiClientUser",
"type": "boolean",
"nested": []
},
{
"field": "authority",
"type": "string",
"nested": []
},
{
"field": "expirationDate",
"type": "string",
"nested": []
},
{
"field": "lastLogin",
"type": "string",
"nested": []
},
{
"field": "lastLoginIp",
"type": "string",
"nested": []
},
{
"field": "readOnly",
"type": "boolean",
"nested": []
},
{
"field": "attribute1value",
"type": "string",
"nested": []
},
{
"field": "attribute2value",
"type": "string",
"nested": []
},
{
"field": "samlEnabled",
"type": "boolean",
"nested": []
}
]
},
{
"name": "detail",
"fields": [
{
"field": "id",
"type": "int",
"nested": []
},
{
"field": "uuid",
"type": "UUID",
"nested": []
},
{
"field": "clientId",
"type": "int",
"nested": []
},
{
"field": "firstName",
"type": "string",
"nested": []
},
{
"field": "lastName",
"type": "string",
"nested": []
},
{
"field": "username",
"type": "string",
"nested": []
},
{
"field": "email",
"type": "string",
"nested": []
},
{
"field": "phoneNumber",
"type": "string",
"nested": []
},
{
"field": "multiClientUser",
"type": "boolean",
"nested": []
},
{
"field": "authority",
"type": "string",
"nested": []
},
{
"field": "expirationDate",
"type": "string",
"nested": []
},
{
"field": "lastLogin",
"type": "string",
"nested": []
},
{
"field": "lastLoginIp",
"type": "string",
"nested": []
},
{
"field": "readOnly",
"type": "boolean",
"nested": []
},
{
"field": "attribute1value",
"type": "string",
"nested": []
},
{
"field": "attribute2value",
"type": "string",
"nested": []
},
{
"field": "samlEnabled",
"type": "boolean",
"nested": []
}
]
}
]
}
Name | Description | Type | Additional Information |
---|---|---|---|
ID | User ID number. | integer
|
|
UUID | User UUID number. | integer
|
|
CLIENTID | Client ID number. | integer
|
|
FIRSTNAME | User's first name. | string
|
|
LASTNAME | User's last name. | string
|
|
USERNAME | User's platform username. | string
|
|
User's email address. | string
|
||
PHONENUMBER | User's phone number. | string
|
|
MULTICLIENTUSER | Is this a multi-client user? | boolean
|
Options: True = Yes, False = No |
AUTHORITY | Authority. | string
|
|
EXPIRATIONDATE | User expiration date. | string
|
|
LASTLOGIN | Last login. | string
|
|
LASTLOGINIP | Lat login IP address. | string
|
|
READONLY | Is this user read only? | boolean
|
Options: True = Yes, False = No |
ATTRIBUTE1VALUE | Attribute 1 value. | string
|
|
ATTRIBUTE2VALUE | Attribute 2 value. | string
|
|
SAMLENABLED | Is SAML enabled? | boolean
|
Options: True = Yes, False = No |
HTTP Status Codes
Code | Description |
---|---|
200 | OK |
200 Sample Response
{
"projections": [
{
"name": "basic",
"fields": [
{
"field": "id",
"type": "integer"
},
{
"field": "name",
"type": "string"
}
]
}
]
}
Code | Description |
---|---|
401 | Unauthorized |
404 | Not Found |
Listing Filterable User Fields
Displays the filterable user fields that can be used by the search endpoint.
API Call: GET/client/{clientId}/user/filter
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/filter
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
User Roles
The user roles that can list filterable user fields are:
- Manager
- Group Manager
- User
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 list_userfields Snippet
curl -X GET "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/filter"
-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
[
{
"name": "Email",
"legacyUid": "email",
"uid": "email",
"operators": [
"EXACT",
"IN",
"LIKE",
"WILDCARD"
],
"type": "string",
"description": ""
},
{
"name": "Expiration Date",
"legacyUid": "expiration_date",
"uid": "expiration_date",
"operators": [
"EXACT",
"IN",
"RANGE"
],
"type": "string",
"description": ""
},
{
"name": "First Name",
"legacyUid": "first_name",
"uid": "firstName",
"operators": [
"EXACT",
"IN",
"LIKE",
"WILDCARD"
],
"type": "string",
"description": ""
},
{
"name": "Id",
"legacyUid": "id",
"uid": "id",
"operators": [
"EXACT",
"IN"
],
"type": "string",
"description": ""
},
{
"name": "Is SAML User",
"legacyUid": "saml_user",
"uid": "saml_user",
"operators": [
"EXACT"
],
"type": "boolean",
"description": ""
},
{
"name": "Last Login",
"legacyUid": "last_login",
"uid": "last_login",
"operators": [
"EXACT",
"IN",
"RANGE"
],
"type": "string",
"description": ""
},
{
"name": "Last Name",
"legacyUid": "last_name",
"uid": "lastName",
"operators": [
"EXACT",
"IN",
"LIKE",
"WILDCARD"
],
"type": "string",
"description": ""
},
{
"name": "Phone Number",
"legacyUid": "phone_number",
"uid": "phoneNumber",
"operators": [
"EXACT",
"IN",
"LIKE",
"WILDCARD"
],
"type": "string",
"description": ""
},
{
"name": "Role",
"legacyUid": "role",
"uid": "role",
"operators": [
"EXACT",
"IN",
"LIKE",
"WILDCARD"
],
"type": "string",
"description": ""
},
{
"name": "Username",
"legacyUid": "username",
"uid": "username",
"operators": [
"EXACT",
"IN",
"LIKE",
"WILDCARD"
],
"type": "string",
"description": ""
}
]
Name | Description | Type | Additional Information |
---|---|---|---|
Email address. | string
|
Filter Options: Exact, In, Like, Wildcard | |
EXPIRATIONDATE | User expiration date | string
|
Filter Options: Exact, In, Range |
FIRSTNAME | User first name. | string
|
Filter Options: Exact, In, Like, Wildcard |
ID | User ID number. | string
|
Filter Options: Exact, In, Like, Wildcard |
ISSAMLUSER | Is the user a SAML user? | boolean
|
Filter Options: Exact |
LASTLOGIN | Last login. | string
|
Filter Options: Exact, In, Range |
LASTNAME | User's last name. | string
|
Filter Options: Exact, In, Like, Wildcard |
PHONENUMBER | User's phone number. | string
|
Filter Options: Exact, In, Like, Wildcard |
ROLE | User's role. | string
|
Filter Options: Exact, In, Like, Wildcard |
USERNAME | User's username. | string
|
Filter Options: Exact, In, Like, Wildcard |
HTTP Status Codes
Code | Description |
---|---|
200 | OK |
200 Sample Response
[
{
"name": "id",
"uid": "id",
"operator": [
"EXACT",
"IN"
],
"type": "integer",
"description": "The id"
}
]
Code | Description |
---|---|
401 | Unauthorized |
404 | Not Found |
Suggesting Filter Values for User Filtering
Displays suggested filter values when filtering users.
API Call: POST/client/{clientId}/user/suggest
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/suggest
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
User Roles
The user roles that can view suggested filter values for users are:
- Manager
- Group Manager
- User
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 |
FIELD | Filter category. | string
|
Y | |
EXCLUSIVE | Exclusive. | boolean
|
Y | Options: True = Exclude values listed in the VALUE field, False = Filter based on VALUE field. |
OPERATOR | Search operator. | string
|
Y | Options: EXACT, IN, LIKE, WILDCARD, RANGE, CIDR |
VALUE | Search value. | string
|
Y |
cURL
cURL Sample filter_uservalues Snippet
curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/suggest"
-H "accept: application/json"
-H "x-api-key: <APIKEY>"
-H "Content-Type: application/json"
-d "{ \"filters\": [ { \"field\": \"<FIELD>\", \"exclusive\": <EXCLUSIVE>, \"operator\": \"<OPERATOR>\", \"value\": \"<VALUE>\" } ], \"filter\": { \"field\": \"<FIELD>\", \"exclusive\": <EXCLUSIVE>, \"operator\": \"<OPERATOR>\", \"value\": \"<VALUE>\" }}"
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 |
FIELD | Filter category. | string
|
Y | |
EXCLUSIVE | Exclusive. | boolean
|
Y | Options: True = Exclude values listed in the VALUE field, False = Filter based on VALUE field. |
OPERATOR | Search operator. | string
|
Y | Options: EXACT, IN, LIKE, WILDCARD, RANGE, CIDR |
VALUE | Search value. | string
|
Y |
Response Parameters
Sample Response
[
{
"key": "<KEY>",
"count": <COUNT>
}
]
Name | Description | Type | Additional Information |
---|---|---|---|
KEY | Value for the field the suggestion was requested for. | string
|
|
COUNT | Count. | integer($int64)
|
HTTP Status Codes
Code | Description |
---|---|
200 | OK |
200 Sample Response
[
{
"key": "string",
"count": 0
}
]
Code | Description |
---|---|
400 | Bad Request |
401 | Unauthorized |
404 | Not Found |
Searching for Users
Search for a user.
API Call: POST/client/{clientId}/user/search
URL: https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/search
URL Parameters
Name | Description | Additional Information |
---|---|---|
PLATFORM | Platform number. | Endpoint URL Structure |
CLIENTID | Client ID number. | Finding Your Client ID |
User Roles
The user roles that can search for users are:
- Group Manager
- Manager
- User
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 |
FIELD | Filter category. | string
|
Y | |
EXCLUSIVE | Exclusive. | boolean
|
Y | Options: True = Exclude values listed in the VALUE field, False = Filter based on VALUE field. |
OPERATOR | Search operator. | string
|
Y | Options: EXACT, IN, LIKE, WILDCARD, RANGE, CIDR |
VALUE | Search value. | string
|
Y | |
PROJECTION | Projection type. | string
|
Y | Options: basic, detailed |
SORTFIELD | Field to sort. | string
|
Y | |
SORTDIRECTION | Sort direction. | string
|
Y | Options: ASC, DESC |
PAGENUMBER | Page to view. | integer
|
Y | First Page: 0 |
PAGESIZE | Page size requested. | integer
|
Y | Shows how many items to display on the page. |
cURL
cURL Sample search_user Snippet
curl -X POST "https://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/search"
-H "accept: application/json"
-H "x-api-key: <APIKEY>"
-H "Content-Type: application/json"
-d "{ \"filterRequest\": { \"filters\": [ { \"field\": \"<FIELD>\", \"exclusive\": <EXCLUSIVE>, \"operator\": \"<OPERATOR>\", \"value\": \"<VALUE>\" } ] }}"
-d "{ \"projection\": \"<PROJECTION>\", \"sort\": [ { \"field\": \"<SORTFIELD>\", \"direction\": \"<SORTDIRECTION>\" } ], \"page\": <PAGENUMBER>, \"size\": <PAGESIZE>}"
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 |
FIELD | Filter category. | string
|
Y | |
EXCLUSIVE | Exclusive. | boolean
|
Y | Options: True = Exclude values listed in the VALUE field, False = Filter based on VALUE field. |
OPERATOR | Search operator. | string
|
Y | Options: EXACT, IN, LIKE, WILDCARD, RANGE, CIDR |
VALUE | Search value. | string
|
Y | |
PROJECTION | Projection type. | string
|
Y | Options: basic, detailed |
SORTFIELD | Field to sort. | string
|
Y | |
SORTDIRECTION | Sort direction. | string
|
Y | Options: ASC, DESC |
PAGENUMBER | Page to view. | integer
|
Y | First Page: 0 |
PAGESIZE | Page size requested. | integer
|
Y | Shows how many items to display on the page. |
Response Parameters
Sample Response
{
"errors": [],
"page": {
"size": <PAGESIZE>,
"totalElements": <TOTALELEMENTS>,
"totalPages": <TOTALPAGES>,
"number": <PAGENUMBER>
},
"_embedded": {
"users": [
{
"id": <USERID>,
"uuid": "<UUID>",
"clientId": <CLIENTID>,
"firstName": "<FIRSTNAME>",
"lastName": "<LASTNAME>",
"username": "<USERNAME>",
"email": "<EMAIL>",
"phoneNumber": "<PHONENUMBER>",
"multiClientUser": <MULTICLIENTUSER>,
"authority": "<AUTHORITY>",
"expirationDate": <EXPIRATIONDATE>,
"lastLogin": "<LASTLOGIN>",
"lastLoginIp": "<LASTLOGINIP>",
"readOnly": <READONLY>,
"attribute1value": <ATTRIBUTE1VALUE>,
"attribute2value": <ATTRIBUTE2VALUE>,
"samlEnabled": <SAMLENABLED>
}
]
},
"_links": {
"self": {
"href": "http://platform<PLATFORM>.risksense.com/api/v1/client/<CLIENTID>/user/search?page=<PAGENUMBER>&size=<PAGESIZE>&sort=<SORTFIELD>,<SORTDIRECTION>"
}
}
}
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 |
USERID | User ID number. | integer
|
|
UUID | User UUID number. | integer
|
|
FIRSTNAME | User's first name. | string
|
|
LASTNAME | User's last name. | string
|
|
User's email address. | string
|
||
PHONENUMBER | User's phone number. | string
|
|
MULTICLIENTUSER | Is this a multi-client user? | boolean
|
Options: True = Yes, False = No |
AUTHORITY | Authority. | string
|
|
EXPIRATIONDATE | Expiration date. | string
|
|
LASTLOGIN | Last login date. | string
|
|
LASTLOGINIP | IP used on last login. | string
|
|
READONLY | Is this user read only? | boolean
|
Options: True = Yes, False = No |
ATTRIBUTE1VALUE | Attribute 1 value. | string
|
|
ATTRIBUTE2VALUE | Attribute 2 value. | string
|
|
SAMLENABLED | Does user use SAML to log in? | boolean
|
Options: True = Yes, False = No |
HTTP Status Codes
Code | Description |
---|---|
200 | Ok |
200 Sample Response
{
"_embedded": {
"strings": [
{}
]
},
"page": {
"size": 0,
"totalElements": 0,
"totalPages": 0,
"number": 0
},
"errors": [
{
"id": "string",
"errorRefId": "string",
"code": 0,
"cause": "string"
}
]
}
Code | Description |
---|---|
400 | Bad Request |
401 | Unauthorized |
404 | Not Found |