Skip to content
  • Auto
  • Light
  • Dark
Get Started

List

List
client.policies.list(PolicyListParamsquery?, RequestOptionsoptions?): listunionnextPageTokenstringListPolicyResponse
get/api/v1/policies

List policies.

Parameters
querypage_sizenumberpage_tokenstringPolicyListParams
Hide ParametersShow Parameters
page_sizenumber
optional

The pageSize field.

formatint32
page_tokenstring
optional

The pageToken field.

Returns
listunionnextPageTokenstringListPolicyResponse
Request example TypeScript
import ConductoroneSDK from 'conductorone-sdk';

const client = new ConductoroneSDK({
  apiKey: 'My API Key',
});

const listPolicyResponse = await client.policies.list();

console.log(listPolicyResponse.list);
200 Example
{
  "list": [
    {
      "description": "description",
      "displayName": "displayName",
      "policySteps": {
        "foo": {
          "steps": [
            {
              "accept": {
                "acceptMessage": "acceptMessage"
              },
              "approval": {
                "agent": {
                  "agentMode": "APPROVAL_AGENT_MODE_UNSPECIFIED",
                  "agentUserId": "agentUserId",
                  "instructions": "instructions",
                  "policyIds": [
                    "string"
                  ]
                },
                "allowedReassignees": [
                  "string"
                ],
                "allowReassignment": true,
                "appOwners": {
                  "allowSelfApproval": true
                },
                "entitlementOwners": {
                  "allowSelfApproval": true,
                  "fallback": true,
                  "fallbackUserIds": [
                    "string"
                  ]
                },
                "escalation": {
                  "escalationComment": "escalationComment",
                  "expiration": "expiration",
                  "reassignToApprovers": {
                    "approverIds": [
                      "string"
                    ]
                  },
                  "replacePolicy": {
                    "policyId": "policyId"
                  }
                },
                "escalationEnabled": true,
                "expression": {
                  "allowSelfApproval": true,
                  "expressions": [
                    "string"
                  ],
                  "fallback": true,
                  "fallbackUserIds": [
                    "string"
                  ]
                },
                "group": {
                  "allowSelfApproval": true,
                  "appGroupId": "appGroupId",
                  "appId": "appId",
                  "fallback": true,
                  "fallbackUserIds": [
                    "string"
                  ]
                },
                "manager": {
                  "allowSelfApproval": true,
                  "fallback": true,
                  "fallbackUserIds": [
                    "string"
                  ]
                },
                "requireApprovalReason": true,
                "requireDenialReason": true,
                "requireReassignmentReason": true,
                "requiresStepUpProviderId": "requiresStepUpProviderId",
                "resourceOwners": {
                  "allowSelfApproval": true,
                  "fallback": true,
                  "fallbackUserIds": [
                    "string"
                  ]
                },
                "self": {
                  "fallback": true,
                  "fallbackUserIds": [
                    "string"
                  ]
                },
                "users": {
                  "allowSelfApproval": true,
                  "userIds": [
                    "string"
                  ]
                },
                "webhook": {
                  "webhookId": "webhookId"
                }
              },
              "provision": {
                "assigned": true,
                "provisionPolicy": {
                  "connector": {
                    "account": {
                      "config": {
                        "foo": "bar"
                      },
                      "connectorId": "connectorId",
                      "doNotSave": {},
                      "saveToVault": {
                        "vaultIds": [
                          "string"
                        ]
                      },
                      "schemaId": "schemaId"
                    },
                    "defaultBehavior": {
                      "connectorId": "connectorId"
                    },
                    "deleteAccount": {
                      "connectorId": "connectorId"
                    }
                  },
                  "delegated": {
                    "appId": "appId",
                    "entitlementId": "entitlementId",
                    "implicit": true
                  },
                  "externalTicket": {
                    "appId": "appId",
                    "connectorId": "connectorId",
                    "externalTicketProvisionerConfigId": "externalTicketProvisionerConfigId",
                    "instructions": "instructions"
                  },
                  "manual": {
                    "instructions": "instructions",
                    "userIds": [
                      "string"
                    ]
                  },
                  "unconfigured": {},
                  "webhook": {
                    "webhookId": "webhookId"
                  }
                },
                "provisionTarget": {
                  "appEntitlementId": "appEntitlementId",
                  "appId": "appId",
                  "appUserId": "appUserId",
                  "grantDuration": "grantDuration"
                }
              },
              "reject": {
                "rejectMessage": "rejectMessage"
              },
              "wait": {
                "commentOnFirstWait": "commentOnFirstWait",
                "commentOnTimeout": "commentOnTimeout",
                "condition": {
                  "condition": "condition"
                },
                "name": "name",
                "timeoutDuration": "timeoutDuration"
              }
            }
          ]
        }
      },
      "policyType": "POLICY_TYPE_UNSPECIFIED",
      "postActions": [
        {
          "certifyRemediateImmediately": true
        }
      ],
      "reassignTasksToDelegates": true,
      "rules": [
        {
          "condition": "condition",
          "policyKey": "policyKey"
        }
      ]
    }
  ],
  "nextPageToken": "nextPageToken"
}