• Home
• Developer Resources
• API Usage Guides

Risk Cloud API: Export Step Permission Sets

Updated on: November 17, 2023

Step Permission Sets are an access type that encompass a collection of steps within an application. As an application builder, step permission sets can be created to correspond to different combinations of steps in your application.

With the Risk Cloud API, step permission set information can be exported along with information on what users are in each step permission set.

Obtain your API Access Token to get started, and for more on step permission sets, refer to our Help Center article Creating Permission Sets for your Applications.

Retrieve Step Permission Sets Endpoints

The Step Permission Sets API offers the following Retrieve Step Permission Sets endpoints which allow API users to either return a list of all step permission sets in the Risk Cloud environment or return detailed information about a particular step permission set such as users and permissions.

Retrieve Step Permission Sets

This endpoint has the following query parameters, which can be left empty for the default use case.

Query Parameter	Description
application-id	The unique ID of an application where, if provided, the response will only contain step permission sets from the identified application.
query	A query parameter flag where, if provided, the response will only contain step permission sets that match the name of either the application, step permission set, or both, depending on the search type specified in search-type.
search-type	A specifier what property name the query applies to. Values include: APPLICATION, PERMISSIONSET, and BOTH

Response

The response contains a JSON array of all step permission sets in the environment. A sample response is shown below.

{
  "content": [
    {
      "id": "a1b2c3d4",
      "name": "Manage Documents",
      "defaultStepPermissionSetForNewUsers": false,
      "stepCount": 2,
      "userCount": 4,
      "roleCount": 3,
      "application": {
        "id": "e5f6g7h8",
        "name": "Cyber Risk Management Application",
        "color": "#00a3de",
        "icon": "fas__fa-cubes",
        "hasDashboard": null,
        "type": null,
        "live": false,
        "permissionsEnabled": false,
        "workflows": []
      }
    }
  ],
  "pageable": {
    "sort": {
      "empty": true,
      "sorted": false,
      "unsorted": true
    },
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 20,
    "unpaged": false,
    "paged": true
  },
  "totalElements": 1,
  "totalPages": 1,
  "last": false,
  "size": 20,
  "number": 0,
  "sort": {
    "empty": true,
    "sorted": false,
    "unsorted": true
  },
  "numberOfElements": 1,
  "first": true,
  "empty": false
}

Retrieve a Step Permission Set

This endpoint has the following required path parameter.

Path Parameter	Description
{step-permission-set-id}	The unique ID of the step permission set to return.

Response

The response contains detailed information on the requested step permission set, including information on associated users and permissions. A sample response is shown below.

{
  "id": "a1b2c3d4",
  "active": true,
  "created": 1642809081423,
  "updated": 1652291058707,
  "name": "Manage Documents",
  "locked": false,
  "defaultStepPermissionSetForNewUsers": false,
  "permissions": [
    {
      "created": null,
      "updated": null,
      "end": {
        "id": "e5f6g7h8",
        "active": true,
        "created": 1642809081185,
        "updated": 1699026534455,
        "stepType": "END",
        "name": "Document Repository",
        "priority": 3,
        "userGroupOperationType": "FULL_ACCESS",
        "xpos": 375,
        "ypos": 55,
        "commentsEnabled": true,
        "documentsEnabled": false,
        "externalUserMfaRequired": false,
        "uxriEnabled": true,
        "workflow": {
          "id": "i9j0k1l2",
          "active": true,
          "created": 1642809081185,
          "updated": 1663870139710,
          "application": null
        },
        "assignableUserType": "APP_AND_EXTERNAL_USERS",
        "end": true,
        "chain": false,
        "origin": false
      },
      "operationType": "EDIT",
      "permissionSetId": null,
      "step": {
        "id": "e5f6g7h8",
        "active": true,
        "created": 1642809081185,
        "updated": 1699026534455,
        "stepType": "END",
        "name": "Document Repository",
        "priority": 3,
        "userGroupOperationType": "FULL_ACCESS",
        "xpos": 375,
        "ypos": 55,
        "commentsEnabled": true,
        "documentsEnabled": false,
        "externalUserMfaRequired": false,
        "uxriEnabled": true,
        "workflow": {
          "id": "i9j0k1l2",
          "active": true,
          "created": 1642809081185,
          "updated": 1663870139710,
          "application": null
        },
        "assignableUserType": "APP_AND_EXTERNAL_USERS",
        "end": true,
        "chain": false,
        "origin": false
      },
      "type": "STEP_PERMISSION",
      "endId": "e5f6g7h8",
      "startId": null
    }
  ],
  "users": [
    {
      "status": "Active",
      "id": "m3n4o5p6",
      "active": true,
      "created": 1574197320453,
      "updated": 1677532088796,
      "email": "[email protected]",
      "imageS3Key": null,
      "first": "Jane",
      "last": "Doe",
      "stepPermissionSetIds": [
        "a1b2c3d4"
      ],
      "roleIds": [],
      "empty": false,
      "idOrTransientId": "m3n4o5p6",
      "transientIdOrId": "m3n4o5p6"
    }
  ],
  "application": {
    "id": "q7r8s9t0",
    "active": true,
    "created": 1642809081193,
    "updated": 1699026534455,
    "name": "Cyber Risk Management Application",
    "createdBy": null,
    "color": "#00a3de",
    "icon": "fas__fa-cubes",
    "type": "CONTROLS_COMPLIANCE",
    "sourceApplicationId": null,
    "sourceEnvironment": null,
    "permissionsEnabled": false,
    "imported": true,
    "copied": false,
    "live": false,
    "calcsV2": true,
    "currency": "USD",
    "uxriEnabled": true
  },
  "applicationId": "q7r8s9t0",
  "userIds": [
    "m3n4o5p6"
  ]
}