List Policies

Edit online

Retrieves the list of policies configured in your organization.]

HTTP request
GET/v2/policies
Authentication
Authentication Type Supported
Organization User (CustomerEmployee) Yes
Delegated User (EndUser) No
Service Account Yes
Required permissions
Policies:Read (always required)
Authorization requirements
Header Type Required Description
Authorization string Yes Bearer token used to authenticate the request. See Authentication flows for instructions on generating this token.
Query parameters
Parameter Type Default Description
limit string None Maximum number of items to return.
paginationToken string None Opaque token used to retrieve the next results page. Minimum length is 1.
status enum string None Filters returned policies by status. Allowed values: Active, Archived.
Request body
curl --request GET \
  --url https://api.digitalassets.ibm.com/v2/policies \
  --header 'Authorization: Bearer <token>'
Response
200: Success

Example response:

{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "status": "Active",
      "activityKind": "Registry:Addresses:Modify",
      "rule": {
        "kind": "AlwaysTrigger",
        "configuration": {}
      },
      "action": {
        "kind": "RequestApproval",
        "approvalGroups": [
          {
            "quorum": 2,
            "approvers": {
              "userId": {
                "in": [
                  "<string>"
                ]
              }
            },
            "name": "<string>",
            "initiatorCanApprove": true
          }
        ],
        "autoRejectTimeout": 2
      },
      "dateCreated": "<string>",
      "dateUpdated": "<string>",
      "filters": {},
      "pendingChangeRequest": {
        "id": "<string>",
        "requester": {
          "userId": "<string>",
          "tokenId": "<string>",
          "appId": "<string>"
        },
        "kind": "Policy",
        "operationKind": "Update",
        "status": "Applied",
        "entityId": "<string>",
        "dateCreated": "2023-11-07T05:31:56Z",
        "body": {
          "id": "<string>",
          "name": "<string>",
          "status": "Active",
          "activityKind": "Registry:Addresses:Modify",
          "rule": {
            "kind": "AlwaysTrigger",
            "configuration": {}
          },
          "action": {
            "kind": "RequestApproval",
            "approvalGroups": [
              {
                "quorum": 2,
                "approvers": {
                  "userId": {
                    "in": [
                      "<string>"
                    ]
                  }
                },
                "name": "<string>",
                "initiatorCanApprove": true
              }
            ],
            "autoRejectTimeout": 2
          },
          "dateCreated": "<string>",
          "dateUpdated": "<string>",
          "filters": {}
        },
        "dateResolved": "2023-11-07T05:31:56Z",
        "approvalId": "<string>"
      }
    }
  ],
  "nextPageToken": "<string>"
}