Risk Cloud API: Assign Records

Updated on: May 02, 2024

Assigning users to records in the Risk Cloud can also be accomplished via the Risk Cloud API.

Obtain your API Access Token or pull the Risk Cloud Postman Collection to get started.

Assign Records Endpoint

The internal Record API offers the following Assign Records endpoint, allowing custom integrations to assign users to records via the Risk Cloud API.

The endpoint is available to all users with Application and Assign entitlements.

PATCH/api/v1/internal/records/assign/{record-id}

This endpoint has the following path parameters.

Path Property Description
record-id The unique ID of the record to assign the passed user to.

This endpoint has the following required request body properties.

{
  "id": "a1b2c3d4",
  "status": "Active"
}
Property Description
id The unique ID of the user to assign to the record.
status A required property to include alongside the request. A value of "Active" is expected.

Use Cases

Get Record ID

The record-id can be obtained from the Risk Cloud web application, emails, or via the Risk Cloud API.

Using the Risk Cloud application

The most straightforward way to find the record ID for record-id is to open the desired record in the Risk Cloud web application, then take the ID from the end of the URL.

https://your-company.logicgate.com/records/{record-id}

Using email

The Contextual Notifications feature offers the ability to set Custom Fields and System Fields in outbound emails. As a result, Record ID is a System Field that can be included in outbound emails from the Risk Cloud. This Record ID could in turn be parsed from the email for use in the following Post Record Comment API request.

Using the Risk Cloud API

Reference the article Risk Cloud API: Record Search to obtain record IDs via the Risk Cloud API.

Get User IDs

The user IDs to add to the newly created group can be obtained from either you Risk Cloud web app environment directly or from the Risk Cloud API.

Get User ID (Web App Environment)

A user ID can be located within you Risk Cloud web app environment in the following location:

  • Navigate to Admin > Users
  • Search for an select a user by clicking their email
  • The user ID can be found in under the User ID label

Get User ID (Risk Cloud API)

A user ID can be located via the User API, specifically in the id property of the returned user objects.

To obtain all users, reference the article Risk Cloud API: Viewing Users.

To obtain a user ID by a particular email, use the following internal User API endpoint.

GET/api/v1/internal/users?search-type=EMAIL&query={email}

Response

{
  "content": [
    {
      "id": "a1b2c3d4",
      "email": "[email protected]",
      // ... truncated ...
    }
  ],
  "pageable": {
    // ... truncated ...
  },
  // ... truncated ...
}

Assign Record

Once the user ID and record ID are obtained, the record can be assigned to the user via the Assign Records endpoint.

PATCH/api/v1/internal/records/assign/{record-id}

Request

Place the record ID in the URL path in the place of {record-id} and place the user ID in the request body in the place of {user-id}.

{
  "id": "{user-id}",
  "status": "Active"
}

Response

Expect a 200 response to confirm the assignment of the user on the record.