GET 
/trusted-policies-registry/v3/policies/:policyName

Returns a trusted policy identified by its name.

Request

Path Parameters

policyName stringrequired
Example: TSR:insertSchema

Responses

200

Success

application/json

Schema

Schema

policyId string

Unique policy ID

description string

policy description

policyName string

Name of the policy

operationType string

Possible values: [AND, OR]

Type of the operation the policy performs ("AND", "OR")

status boolean

Status of the policy (false = inactive, true = active)

policyConditions object[]
List of policy conditions
Array [
name string
Name of the condition
attributeName string
Name of the attribute to validate
typeOfValue string
Possible values: [UINT256, BYTES, ADDRESS, BYTES32, STRING, BOOLEAN]
Expected attribute type. Valid types include: "UINT256", "BYTES", "ADDRESS", "BYTES32", "STRING", "BOOLEAN".
attributeOperation string
Possible values: [EQUAL]
Operation to apply ("EQUAL" only)
value object
Value to compare the attribute to
oneOf
MOD1
string
MOD2
boolean
]

Example (from schema)

{
  "policyId": "string",
  "description": "string",
  "policyName": "string",
  "operationType": "AND",
  "status": true,
  "policyConditions": [
    {
      "name": "string",
      "attributeName": "string",
      "typeOfValue": "UINT256",
      "attributeOperation": "EQUAL",
      "value": "string"
    }
  ]
}

Success

{
  "policyId": "0",
  "description": "description-test-036ccfd98b88a9c3ad1a23e730bc414f",
  "policyName": "policy-test-fd0010fa07c2ff3eba04a46547687d17",
  "operationType": "AND",
  "status": true,
  "policyConditions": [
    {
      "name": "condition-string",
      "attributeName": "any",
      "typeOfValue": "STRING",
      "value": "vxc4gdbfgb",
      "attributeOperation": "EQUAL"
    },
    {
      "name": "condition-bytes",
      "attributeName": "any",
      "typeOfValue": "BYTES",
      "value": "0x61736461736464",
      "attributeOperation": "EQUAL"
    },
    {
      "name": "condition-boolean",
      "attributeName": "any",
      "typeOfValue": "BOOLEAN",
      "value": false,
      "attributeOperation": "EQUAL"
    },
    {
      "name": "condition-address",
      "attributeName": "any",
      "typeOfValue": "ADDRESS",
      "value": "0x00000000219ab540356cbb839cbe05303d7705fa",
      "attributeOperation": "EQUAL"
    },
    {
      "name": "condition-uint256",
      "attributeName": "any",
      "typeOfValue": "UINT256",
      "value": "42",
      "attributeOperation": "EQUAL"
    }
  ]
}

400

Bad Request

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

Invalid {policyId} Parameter

{
  "title": "Bad Request",
  "status": 400,
  "detail": "The format of {policyId} parameter is not valid"
}

404

Not found

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

Policy Not Found

{
  "title": "Not found",
  "status": 404,
  "detail": "Not found"
}

500

Internal Error

application/problem+json

Schema

Schema

type uri

Default value: about:blank

An absolute URI that identifies the problem type. When dereferenced, it SHOULD provide human-readable documentation for the problem type.

title string

A short summary of the problem type.

status int32

Possible values: >= 400 and <= 600

The HTTP status code generated by the origin server for this occurrence of the problem.

detail string

A human readable explanation specific to this occurrence of the problem.

instance uri

An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (from schema)

{
  "type": "about:blank",
  "title": "Internal Server Error",
  "status": 500,
  "detail": "Connection timeout",
  "instance": "string"
}

Internal Server Error

{
  "title": "Internal Server Error",
  "status": 500,
  "detail": "The server encountered an internal error and was unable to process your request."
}

Loading...