API docs by Redocly

Policy Store (1.0)

Download OpenAPI specification:Download

RetrievePolicy, UpdatedPolicy

Retrieves all policies from the store. Use limit and start parameters for pagination.

query Parameters
limit
integer <int32>

Maximum number of results to return

start
integer <int32> >= 1

First item in the page of results, as an ordinal 1-based integer

policyOwner
string

ID of the Agency owning policy(ies)

policyType
string

Type of the policy

policyQueueName
string <uri>

Policy queue name

policyId
string

Id of the policy

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "totalCount": 0,
  • "policies": [
    ]
}

CreatePolicy

Creates a new policy in the Policy Store

Request Body schema: application/json
required

Policy to add (JWS using flattened JSON serialization)

payload
required
string <byte>
protected
required
string <byte>
signature
required
string <byte>

Responses

Request samples

Content type
application/json
{
  • "payload": "string",
  • "protected": "string",
  • "signature": "string"
}

UpdatePolicy

Updates an existing policy. In order to identify a policy the following parameters must be specified - policyType, policyQueueName OR policyId.

query Parameters
policyOwner
required
string

Owner of the policy

policyType
required
string

Type of the policy

policyQueueName
string <uri>

Policy queue name

policyId
string

Id of the policy

Request Body schema: application/json
required

Policy to update (JWS using flattened JSON serialization)

payload
required
string <byte>
protected
required
string <byte>
signature
required
string <byte>

Responses

Request samples

Content type
application/json
{
  • "payload": "string",
  • "protected": "string",
  • "signature": "string"
}

DeletePolicy

Deletes an existing policy. In order to identify a policy the following parameters must be specified - policyType, policyQueueName OR policyId.

query Parameters
policyOwner
required
string

Owner of the policy

policyType
required
string

Type of the policy

policyQueueName
string <uri>

Policy queue name

policyId
string

Id of the policy

Responses

EnumeratePolicy

Returns a list of policy types available in the store for a specific agency/service. Use limit and start parameters for pagination.

query Parameters
limit
integer <int32>

Maximum number of results to return

start
integer <int32> >= 1

First item in the page of results, as an ordinal 1-based integer

policyOwner
string

ID of the Agency owning policy(ies)

policyType
required
string

Type of the policy

policyQueueName
string <uri>

Policy queue name

policyId
string

Id of the policy

policiesUpdatedSince
string <date-time>
Example: policiesUpdatedSince=2020-03-10T10:00:00-05:00

The query will return all policies having the time of creation or last modification greater than policiesUpdatedSince

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "totalCount": 0,
  • "policyEnums": [
    ]
}

RetrieveVersions

Retrieves all supported versions, vendor parameter is optional.

Responses

Response samples

Content type
application/json
{
  • "versions": [
    ],
  • "fingerprint": "string"
}