Policies

Policy management operations

List policies

get

Lists policies

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Query parameters
typestringOptional

Filter by policy type

limitinteger · min: 1Optional

Requests a page size of items

markerstringOptional

The ID of the last-seen item for pagination

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Responses
200

Policies listed successfully

application/json
get
/policies
GET /v3/policies HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
{
  "policies": [
    {
      "id": "text",
      "type": "text",
      "blob": {},
      "links": {
        "self": "text",
        "previous": "text",
        "next": "text"
      }
    }
  ],
  "links": {
    "self": "text",
    "previous": "text",
    "next": "text"
  }
}

Create policy

post

Creates a policy

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Body
Responses
post
/policies
POST /v3/policies HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "policy": {
    "type": "text",
    "blob": {}
  }
}
{
  "policy": {
    "id": "text",
    "type": "text",
    "blob": {},
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Show policy details

get

Shows details for a policy

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
policy_idstringRequired

The policy ID

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Responses
200

Policy details retrieved successfully

application/json
get
/policies/{policy_id}
GET /v3/policies/{policy_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*
{
  "policy": {
    "id": "text",
    "type": "text",
    "blob": {},
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Delete policy

delete

Deletes a policy

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
policy_idstringRequired

The policy ID

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Responses
delete
/policies/{policy_id}
DELETE /v3/policies/{policy_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Accept: */*

No content

Update policy

patch

Updates a policy

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
policy_idstringRequired

The policy ID

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Body
Responses
200

Policy updated successfully

application/json
patch
/policies/{policy_id}
PATCH /v3/policies/{policy_id} HTTP/1.1
Host: identity.example.com
X-Auth-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "policy": {
    "type": "text",
    "blob": {}
  }
}
{
  "policy": {
    "id": "text",
    "type": "text",
    "blob": {},
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Last updated

Was this helpful?