Policies

List policies.

Changed on

Returns a list of policies.

get/v2/policies

Request

  • Base URL: https://api.openfort.io
  • URL: https://api.openfort.io/v2/policies
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

limitinteger

Specifies the maximum number of records to return.

skipinteger

Specifies the offset for the first records to return.

order'asc' | 'desc'

Specifies the order in which to sort the results.

scopestring[]

Filter by scope.

enabledboolean

Filter by enabled status.

accountIdstring

Filter by account ID (for account-scoped policies).

operationstring[]

Only include policies that have at least one rule with an operation in this list.

operationNotInstring[]

Exclude policies where all rules have operations in this list.

Response

Successful response.

object'list' required
urlstring required
startinteger required
endinteger required
totalinteger required

Example response

{
  "data": [
    {
      "description": "Limit ETH transfers to 1 ETH to approved addresses",
      "accountId": "acc_48eeba57-2cd5-4159-a2cb-057a23a35e65",
      "enabled": true,
      "rules": [
        {
          "operation": "signEvmTransaction"
        }
      ]
    }
  ]
}

Changes

  • 88be7ccfca19Revision changes
    • info

      the security scope policies:read was added to the endpoint's security scheme sk

    • info

      added the new optional query request parameter operation

    • info

      added the new optional query request parameter operationNotIn

  • 1cf297765e36Revision changes
    • breaking

      removed the enum value account from the query request parameter scope

    • breaking

      removed the enum value project from the query request parameter scope

    • warning

      added the new transaction enum value to the // response property for the response status

    • info

      for the query request parameter scope, the type was generalized from string to array