**Please Read**
The LogicGate Risk Cloud Developer Portal is the best resource for API documentation and the full collection of RESTful API endpoints. You can review details about accessing User data via the Risk Cloud API by clicking on the link below. We would also recommend replacing the bookmark for this Help Center article with the Developer Portal link.
Important Note: This article might be removed from the Help Center by August 2025, however, you will be able to access the most updated information in the Developer Portal.
This article walks through obtaining User information for review and future API requests via the Risk Cloud API.
API Authentication
Prior to any interaction with Risk Cloud API we will need to obtain an Access Token for the Authorization header. Instructions on how the Access Token can be obtained can be found here.
Permissions
Listing all Users via the Risk Cloud API requires an Access Token from an Admin Primary account.
Background
When working with the Risk Cloud via the API, it is common to require IDs for Users for accomplishing tasks from as enabling and disabling Users to assigning Users to Records.
The following endpoint will return an array of all Users in your Risk Cloud environment.
Usage
To obtain a list of all Users in your environment, make the following request.
curl --request GET 'https://your-company.logicgate.com/api/v1/users' \
--header 'Authorization: Bearer {ACCESS_TOKEN}'
The response will contain an array of all Users in your environment, the IDs of which can be located as the values for id
properties for usage in future API requests.
[
{
"active": true,
"convertibleTo": [
null
],
"created": "2019-08-24T14:15:22Z",
"currentValues": [
null
],
"defaultValues": [
null
],
"discrete": true,
"fieldType": "[",
"global": true,
"id": "string",
"label": "string",
"labels": [
null
],
"name": "string",
"operators": [
null
],
"tooltip": "string",
"updated": "2019-08-24T14:15:22Z",
"validTypeForCalculationInput": true,
"valueType": "string",
"workflow": {},
"workflowId": "string",
"allowLocalLogin": true,
"applicationEntitlements": [
null
],
"archived": true,
"autoprovisioned": true,
"company": "string",
"defaultField": {},
"disabled": true,
"discriminator": "string",
"email": "string",
"empty": true,
"external": true,
"field": {},
"fieldId": "string",
"first": "string",
"idOrTransientId": "string",
"imageUrl": "string",
"intercomHash": "string",
"isDefault": true,
"languageTag": "string",
"last": "string",
"lastLogin": {},
"locked": true,
"loginAttempts": 0,
"modulePermissionSets": [
null
],
"notificationPreference": true,
"numericValue": 0,
"password": "string",
"priority": 0,
"records": [
null
],
"resetPasswordToken": "string",
"roles": [
null
],
"scimStatus": "string",
"sendEmail": true,
"serviceAccount": true,
"status": "string",
"stepPermissionSets": [
null
],
"superUser": true,
"textValue": "string",
"tier": "[",
"timeZone": "string",
"transientIdOrId": "string"
}
]
Comments
0 comments
Please sign in to leave a comment.