GET

List actions

Lists all available actions for a given touchpoint and scope.

Path Params

enterpriseId string required

Your Enterprise Id.
touchpointId string required

The id of a Touchpoint.
filteringCondition string required

The name of the Filtering condition to be used when creating or updating a policy rule. Not all Touchpoint Actions are compatible with all Filtering Conditions.

Responses

200

All available Actions on a given Touchpoint.

Response Body

object

Wrapper object for a list of Actions. Not paginated.

actions array of objects required
ANY OF
- name string enum required
  
  The name of the action.
  
  approvals.always.deny
- label string required
  
  A label for the action which can be shown to an end user.
- description string required
  
  A description for the action which can be shown to an end user.
- status string enum required
  Status of the action. Indicates if the Actions is usable ACTIVE or not INACTIVE.
  
  ACTIVE - The action is available for use.
  
  INACTIVE - The action is NOT available for use.
  ACTIVEINACTIVE
- adminOnly boolean required
  
  true, if this is an internal action, false otherwise.
- name string enum required
  
  The name of the action.
  
  approvals.customer.walletAdmin
- label string required
  
  A label for the action which can be shown to an end user.
- description string required
  
  A description for the action which can be shown to an end user.
- status string enum required
  Status of the action. Indicates if the Actions is usable ACTIVE or not INACTIVE.
  
  ACTIVE - The action is available for use.
  
  INACTIVE - The action is NOT available for use.
  ACTIVEINACTIVE
- adminOnly boolean required
  
  true, if this is an internal action, false otherwise.
- parameters array of objects required
  
  A list of Parameters to control how the action behaves.
  ANY OF
  
  name string enum required
  
  The name of the action parameter.
  
  minRequired
  
  label string required
  
  A label for the action parameter which can be shown to an end user.
  
  description string required
  
  A description for the action parameter which can be shown to an end user.
  
  type string enum required
  
  The type of acceptable values for this action parameter.
  
  POSITIVE_NUMBER
  
  required string enum required
  
  A value must always be provided, i.e. the parameter is required.
  
  ALWAYS
  
  allowMultiple boolean required
  
  true, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected.
- name string enum required
  
  The name of the action.
  
  approvals.customer.finalApproval
- label string required
  
  A label for the action which can be shown to an end user.
- description string required
  
  A description for the action which can be shown to an end user.
- status string enum required
  Status of the action. Indicates if the Actions is usable ACTIVE or not INACTIVE.
  
  ACTIVE - The action is available for use.
  
  INACTIVE - The action is NOT available for use.
  ACTIVEINACTIVE
- adminOnly boolean required
  
  true, if this is an internal action, false otherwise.
- parameters array of objects required
  
  A list of Parameters to control how the action behaves.
  ANY OF
  
  name string enum required
  
  The name of the action parameter.
  
  userIds
  
  label string required
  
  A label for the action parameter which can be shown to an end user.
  
  description string required
  
  A description for the action parameter which can be shown to an end user.
  
  type string enum required
  
  The type of acceptable values for this action parameter.
  
  BITGO_USER_ID
  
  required string enum required
  
  A value must be always provided for exactly one or more of the action Parameters with a 'required' value of ONE_OR_MORE. In other words, all the action Parameters with a 'required' of ONE_OR_MORE form a group, and a value must be provided for one or more of the action Parameters in the group.
  
  ONE_OR_MORE
  
  allowMultiple boolean required
  
  true, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected.
- name string enum required
  
  The name of the action.
  
  approvals.customer.enterpriseAdmin
- label string required
  
  A label for the action which can be shown to an end user.
- description string required
  
  A description for the action which can be shown to an end user.
- status string enum required
  Status of the action. Indicates if the Actions is usable ACTIVE or not INACTIVE.
  
  ACTIVE - The action is available for use.
  
  INACTIVE - The action is NOT available for use.
  ACTIVEINACTIVE
- adminOnly boolean required
  
  true, if this is an internal action, false otherwise.
- name string enum required
  
  The name of the action.
  
  approvals.customer.enterpriseUser
- label string required
  
  A label for the action which can be shown to an end user.
- description string required
  
  A description for the action which can be shown to an end user.
- status string enum required
  Status of the action. Indicates if the Actions is usable ACTIVE or not INACTIVE.
  
  ACTIVE - The action is available for use.
  
  INACTIVE - The action is NOT available for use.
  ACTIVEINACTIVE
- adminOnly boolean required
  
  true, if this is an internal action, false otherwise.
- parameters array of objects required
  
  A list of Parameters to control how the action behaves.
  ANY OF
  
  name string enum required
  
  The name of the action parameter.
  
  userIds
  
  label string required
  
  A label for the action parameter which can be shown to an end user.
  
  description string required
  
  A description for the action parameter which can be shown to an end user.
  
  type string enum required
  
  The type of acceptable values for this action parameter.
  
  BITGO_USER_ID
  
  required string enum required
  
  A value must be always provided for exactly one or more of the action Parameters with a 'required' value of ONE_OR_MORE. In other words, all the action Parameters with a 'required' of ONE_OR_MORE form a group, and a value must be provided for one or more of the action Parameters in the group.
  
  ONE_OR_MORE
  
  allowMultiple boolean required
  
  true, if multiple values can be provided, i.e. as a list of values. When false only one value can be provided, i.e. a list with more than one element will be rejected.

401

Unauthorized

Response Body

object

code string
message string
status integer

403

Forbidden

Response Body

object

code string
message string
status integer

404

The specified resource was not found

Response Body

object

code string
message string
status integer

500

Server Error - Transient error please try again

Response Body

object

code string
message string
status integer

curl --request GET \ --url 'https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointId/filteringconditions/filteringCondition/actions' \ --header 'accept: application/json' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

const url = 'https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointId/filteringconditions/filteringCondition/actions'; const options = {method: 'GET', headers: {accept: 'application/json', 'Authorization': 'Bearer YOUR_ACCESS_TOKEN'}}; fetch(url, options) .then(res => res.json()) .then(json => console.log(json)) .catch(err => console.error(err));

require 'uri' require 'net/http' url = URI("https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointId/filteringconditions/filteringCondition/actions") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = 'application/json' request["Authorization"] = 'Bearer YOUR_ACCESS_TOKEN' response = http.request(request) puts response.read_body

<?php require_once('vendor/autoload.php'); $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointId/filteringconditions/filteringCondition/actions', [ 'headers' => [ 'accept' => 'application/json', 'Authorization' => 'Bearer YOUR_ACCESS_TOKEN', ], ]); echo $response->getBody();

import requests url = "https://app.bitgo-test.com/api/policy/v1/enterprises/enterpriseId/touchpoints/touchpointId/filteringconditions/filteringCondition/actions" headers = { "accept": "application/json", "Authorization": "Bearer YOUR_ACCESS_TOKEN" } response = requests.get(url, headers=headers) print(response.text)

{ "actions": [ { "adminOnly": false, "description": "Automatically reject", "label": "Deny", "name": "approvals.always.deny", "parameters": [], "status": "ACTIVE" }, { "adminOnly": false, "description": "Require approval from wallet admins", "label": "Wallet Admin", "name": "approvals.customer.walletAdmin", "parameters": [ { "allowMultiple": false, "description": "Minimum required number of approvers", "label": "Approvals Required", "name": "minRequired", "required": "OPTIONAL", "type": "NON_NEGATIVE_NUMBER", "values": [] } ], "status": "ACTIVE" }, { "adminOnly": false, "description": "Require final approval from wallet users", "label": "Require final approval from wallet users", "name": "approvals.customer.finalApproval", "parameters": [ { "allowMultiple": true, "description": "List of users for final approval", "label": "Users", "name": "userIds", "required": "ONE_OR_MORE", "type": "BITGO_ID", "values": [] } ], "status": "ACTIVE" } ] }