Create a new StepPermissionSet - Risk Cloud Developer Portal

Create a new StepPermissionSet. Be sure any permissions specified in the request payload are compatible with the application specified there. An application is required.

curl --request POST \
  --url https://{subdomain}.logicgate.com/api/v1/step-permission-sets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "application": {
    "id": "<string>"
  },
  "active": true,
  "locked": true,
  "defaultStepPermissionSetForNewUsers": true,
  "permissions": [
    {
      "type": "<string>",
      "step": {
        "id": "<string>"
      }
    }
  ],
  "users": [
    {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "discriminator": "<string>",
      "status": "<string>",
      "idOrTransientId": "<string>",
      "transientIdOrId": "<string>",
      "textOrNumericValue": "<string>",
      "empty": true,
      "email": "<string>",
      "first": "<string>",
      "last": "<string>"
    }
  ]
}
'

import requests

url = "https://{subdomain}.logicgate.com/api/v1/step-permission-sets"

payload = {
    "name": "<string>",
    "application": { "id": "<string>" },
    "active": True,
    "locked": True,
    "defaultStepPermissionSetForNewUsers": True,
    "permissions": [
        {
            "type": "<string>",
            "step": { "id": "<string>" }
        }
    ],
    "users": [
        {
            "id": "<string>",
            "active": True,
            "created": "2023-11-07T05:31:56Z",
            "updated": "2023-11-07T05:31:56Z",
            "discriminator": "<string>",
            "status": "<string>",
            "idOrTransientId": "<string>",
            "transientIdOrId": "<string>",
            "textOrNumericValue": "<string>",
            "empty": True,
            "email": "<string>",
            "first": "<string>",
            "last": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    application: {id: '<string>'},
    active: true,
    locked: true,
    defaultStepPermissionSetForNewUsers: true,
    permissions: [{type: '<string>', step: {id: '<string>'}}],
    users: [
      {
        id: '<string>',
        active: true,
        created: '2023-11-07T05:31:56Z',
        updated: '2023-11-07T05:31:56Z',
        discriminator: '<string>',
        status: '<string>',
        idOrTransientId: '<string>',
        transientIdOrId: '<string>',
        textOrNumericValue: '<string>',
        empty: true,
        email: '<string>',
        first: '<string>',
        last: '<string>'
      }
    ]
  })
};

fetch('https://{subdomain}.logicgate.com/api/v1/step-permission-sets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{subdomain}.logicgate.com/api/v1/step-permission-sets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'application' => [
        'id' => '<string>'
    ],
    'active' => true,
    'locked' => true,
    'defaultStepPermissionSetForNewUsers' => true,
    'permissions' => [
        [
                'type' => '<string>',
                'step' => [
                                'id' => '<string>'
                ]
        ]
    ],
    'users' => [
        [
                'id' => '<string>',
                'active' => true,
                'created' => '2023-11-07T05:31:56Z',
                'updated' => '2023-11-07T05:31:56Z',
                'discriminator' => '<string>',
                'status' => '<string>',
                'idOrTransientId' => '<string>',
                'transientIdOrId' => '<string>',
                'textOrNumericValue' => '<string>',
                'empty' => true,
                'email' => '<string>',
                'first' => '<string>',
                'last' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{subdomain}.logicgate.com/api/v1/step-permission-sets"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"application\": {\n    \"id\": \"<string>\"\n  },\n  \"active\": true,\n  \"locked\": true,\n  \"defaultStepPermissionSetForNewUsers\": true,\n  \"permissions\": [\n    {\n      \"type\": \"<string>\",\n      \"step\": {\n        \"id\": \"<string>\"\n      }\n    }\n  ],\n  \"users\": [\n    {\n      \"id\": \"<string>\",\n      \"active\": true,\n      \"created\": \"2023-11-07T05:31:56Z\",\n      \"updated\": \"2023-11-07T05:31:56Z\",\n      \"discriminator\": \"<string>\",\n      \"status\": \"<string>\",\n      \"idOrTransientId\": \"<string>\",\n      \"transientIdOrId\": \"<string>\",\n      \"textOrNumericValue\": \"<string>\",\n      \"empty\": true,\n      \"email\": \"<string>\",\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{subdomain}.logicgate.com/api/v1/step-permission-sets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"application\": {\n    \"id\": \"<string>\"\n  },\n  \"active\": true,\n  \"locked\": true,\n  \"defaultStepPermissionSetForNewUsers\": true,\n  \"permissions\": [\n    {\n      \"type\": \"<string>\",\n      \"step\": {\n        \"id\": \"<string>\"\n      }\n    }\n  ],\n  \"users\": [\n    {\n      \"id\": \"<string>\",\n      \"active\": true,\n      \"created\": \"2023-11-07T05:31:56Z\",\n      \"updated\": \"2023-11-07T05:31:56Z\",\n      \"discriminator\": \"<string>\",\n      \"status\": \"<string>\",\n      \"idOrTransientId\": \"<string>\",\n      \"transientIdOrId\": \"<string>\",\n      \"textOrNumericValue\": \"<string>\",\n      \"empty\": true,\n      \"email\": \"<string>\",\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.logicgate.com/api/v1/step-permission-sets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"application\": {\n    \"id\": \"<string>\"\n  },\n  \"active\": true,\n  \"locked\": true,\n  \"defaultStepPermissionSetForNewUsers\": true,\n  \"permissions\": [\n    {\n      \"type\": \"<string>\",\n      \"step\": {\n        \"id\": \"<string>\"\n      }\n    }\n  ],\n  \"users\": [\n    {\n      \"id\": \"<string>\",\n      \"active\": true,\n      \"created\": \"2023-11-07T05:31:56Z\",\n      \"updated\": \"2023-11-07T05:31:56Z\",\n      \"discriminator\": \"<string>\",\n      \"status\": \"<string>\",\n      \"idOrTransientId\": \"<string>\",\n      \"transientIdOrId\": \"<string>\",\n      \"textOrNumericValue\": \"<string>\",\n      \"empty\": true,\n      \"email\": \"<string>\",\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "active": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "locked": true,
  "defaultStepPermissionSetForNewUsers": true,
  "permissions": [
    {
      "type": "<string>",
      "step": {
        "id": "<string>"
      },
      "operationType": "READ"
    }
  ],
  "users": [
    {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "discriminator": "<string>",
      "status": "<string>",
      "idOrTransientId": "<string>",
      "transientIdOrId": "<string>",
      "textOrNumericValue": "<string>",
      "empty": true,
      "email": "<string>",
      "first": "<string>",
      "last": "<string>"
    }
  ],
  "application": {
    "id": "<string>"
  },
  "applicationId": "<string>",
  "userIds": [
    "<string>"
  ]
}

POST

api

step-permission-sets

Create a new StepPermissionSet. Be sure any permissions specified in the request payload are compatible with the application specified there. An application is required.

curl --request POST \
  --url https://{subdomain}.logicgate.com/api/v1/step-permission-sets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "application": {
    "id": "<string>"
  },
  "active": true,
  "locked": true,
  "defaultStepPermissionSetForNewUsers": true,
  "permissions": [
    {
      "type": "<string>",
      "step": {
        "id": "<string>"
      }
    }
  ],
  "users": [
    {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "discriminator": "<string>",
      "status": "<string>",
      "idOrTransientId": "<string>",
      "transientIdOrId": "<string>",
      "textOrNumericValue": "<string>",
      "empty": true,
      "email": "<string>",
      "first": "<string>",
      "last": "<string>"
    }
  ]
}
'

import requests

url = "https://{subdomain}.logicgate.com/api/v1/step-permission-sets"

payload = {
    "name": "<string>",
    "application": { "id": "<string>" },
    "active": True,
    "locked": True,
    "defaultStepPermissionSetForNewUsers": True,
    "permissions": [
        {
            "type": "<string>",
            "step": { "id": "<string>" }
        }
    ],
    "users": [
        {
            "id": "<string>",
            "active": True,
            "created": "2023-11-07T05:31:56Z",
            "updated": "2023-11-07T05:31:56Z",
            "discriminator": "<string>",
            "status": "<string>",
            "idOrTransientId": "<string>",
            "transientIdOrId": "<string>",
            "textOrNumericValue": "<string>",
            "empty": True,
            "email": "<string>",
            "first": "<string>",
            "last": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    application: {id: '<string>'},
    active: true,
    locked: true,
    defaultStepPermissionSetForNewUsers: true,
    permissions: [{type: '<string>', step: {id: '<string>'}}],
    users: [
      {
        id: '<string>',
        active: true,
        created: '2023-11-07T05:31:56Z',
        updated: '2023-11-07T05:31:56Z',
        discriminator: '<string>',
        status: '<string>',
        idOrTransientId: '<string>',
        transientIdOrId: '<string>',
        textOrNumericValue: '<string>',
        empty: true,
        email: '<string>',
        first: '<string>',
        last: '<string>'
      }
    ]
  })
};

fetch('https://{subdomain}.logicgate.com/api/v1/step-permission-sets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{subdomain}.logicgate.com/api/v1/step-permission-sets",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'application' => [
        'id' => '<string>'
    ],
    'active' => true,
    'locked' => true,
    'defaultStepPermissionSetForNewUsers' => true,
    'permissions' => [
        [
                'type' => '<string>',
                'step' => [
                                'id' => '<string>'
                ]
        ]
    ],
    'users' => [
        [
                'id' => '<string>',
                'active' => true,
                'created' => '2023-11-07T05:31:56Z',
                'updated' => '2023-11-07T05:31:56Z',
                'discriminator' => '<string>',
                'status' => '<string>',
                'idOrTransientId' => '<string>',
                'transientIdOrId' => '<string>',
                'textOrNumericValue' => '<string>',
                'empty' => true,
                'email' => '<string>',
                'first' => '<string>',
                'last' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{subdomain}.logicgate.com/api/v1/step-permission-sets"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"application\": {\n    \"id\": \"<string>\"\n  },\n  \"active\": true,\n  \"locked\": true,\n  \"defaultStepPermissionSetForNewUsers\": true,\n  \"permissions\": [\n    {\n      \"type\": \"<string>\",\n      \"step\": {\n        \"id\": \"<string>\"\n      }\n    }\n  ],\n  \"users\": [\n    {\n      \"id\": \"<string>\",\n      \"active\": true,\n      \"created\": \"2023-11-07T05:31:56Z\",\n      \"updated\": \"2023-11-07T05:31:56Z\",\n      \"discriminator\": \"<string>\",\n      \"status\": \"<string>\",\n      \"idOrTransientId\": \"<string>\",\n      \"transientIdOrId\": \"<string>\",\n      \"textOrNumericValue\": \"<string>\",\n      \"empty\": true,\n      \"email\": \"<string>\",\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{subdomain}.logicgate.com/api/v1/step-permission-sets")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"application\": {\n    \"id\": \"<string>\"\n  },\n  \"active\": true,\n  \"locked\": true,\n  \"defaultStepPermissionSetForNewUsers\": true,\n  \"permissions\": [\n    {\n      \"type\": \"<string>\",\n      \"step\": {\n        \"id\": \"<string>\"\n      }\n    }\n  ],\n  \"users\": [\n    {\n      \"id\": \"<string>\",\n      \"active\": true,\n      \"created\": \"2023-11-07T05:31:56Z\",\n      \"updated\": \"2023-11-07T05:31:56Z\",\n      \"discriminator\": \"<string>\",\n      \"status\": \"<string>\",\n      \"idOrTransientId\": \"<string>\",\n      \"transientIdOrId\": \"<string>\",\n      \"textOrNumericValue\": \"<string>\",\n      \"empty\": true,\n      \"email\": \"<string>\",\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.logicgate.com/api/v1/step-permission-sets")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"application\": {\n    \"id\": \"<string>\"\n  },\n  \"active\": true,\n  \"locked\": true,\n  \"defaultStepPermissionSetForNewUsers\": true,\n  \"permissions\": [\n    {\n      \"type\": \"<string>\",\n      \"step\": {\n        \"id\": \"<string>\"\n      }\n    }\n  ],\n  \"users\": [\n    {\n      \"id\": \"<string>\",\n      \"active\": true,\n      \"created\": \"2023-11-07T05:31:56Z\",\n      \"updated\": \"2023-11-07T05:31:56Z\",\n      \"discriminator\": \"<string>\",\n      \"status\": \"<string>\",\n      \"idOrTransientId\": \"<string>\",\n      \"transientIdOrId\": \"<string>\",\n      \"textOrNumericValue\": \"<string>\",\n      \"empty\": true,\n      \"email\": \"<string>\",\n      \"first\": \"<string>\",\n      \"last\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "active": true,
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "locked": true,
  "defaultStepPermissionSetForNewUsers": true,
  "permissions": [
    {
      "type": "<string>",
      "step": {
        "id": "<string>"
      },
      "operationType": "READ"
    }
  ],
  "users": [
    {
      "id": "<string>",
      "active": true,
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "discriminator": "<string>",
      "status": "<string>",
      "idOrTransientId": "<string>",
      "transientIdOrId": "<string>",
      "textOrNumericValue": "<string>",
      "empty": true,
      "email": "<string>",
      "first": "<string>",
      "last": "<string>"
    }
  ],
  "application": {
    "id": "<string>"
  },
  "applicationId": "<string>",
  "userIds": [
    "<string>"
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

required

Minimum string length: 1

application

object

required

Show child attributes

active

boolean

required

locked

boolean

required

defaultStepPermissionSetForNewUsers

boolean

required

permissions

object[]

required

Show child attributes

users

object[]

required

Entity for storing all information pertaining to a user.

Option 1
Option 2
Option 3
Option 4

Show child attributes

Response

201 - application/json

Created

string

required

active

boolean

required

created

string<date-time>

required

updated

string<date-time>

required

name

string

required

locked

boolean

required

defaultStepPermissionSetForNewUsers

boolean

required

permissions

object[]

required

Show child attributes

users

object[]

required

Entity for storing all information pertaining to a user.

Option 1
Option 2
Option 3
Option 4

Show child attributes

application

object

required

Show child attributes

applicationId

string

required

userIds

string[]

required