Policies

Last updated 6 months ago

Was this helpful?

List policies

get

Query parameters

liststring · enumrequired

Must be set to true

Available options:

Responses

application/json

objectoptional

get

GET /v1/auth/ratls/policies/?list=true HTTP/1.1
Host: 
Accept: */*

200

{
  "auth": {},
  "data": {
    "keys": [
      {}
    ]
  }
}

Read policy

get

Path parameters

namestringrequired

Name of the policy

Responses

application/json

objectoptional

get

GET /v1/auth/ratls/policies/{name} HTTP/1.1
Host: 
Accept: */*

200

{
  "auth": {},
  "data": {
    "created": 1,
    "identities": {},
    "name": "text"
  }
}

Delete policy

delete

Path parameters

namestringrequired

Name of the policy

Responses

delete

DELETE /v1/auth/ratls/policies/{name} HTTP/1.1
Host: 
Accept: */*

200

No Content

Create policy

put

Body

createdinteger · int64required

Creation timestamp, set by the plugin

identitiesobject · maprequired

A map of all identity types with their respective selector

Default:

{"provider":"azure-sev-snp-vtpm","platform":null,"firmware":[{"name":"azure-dc2asv5","policy":null},{"name":"azure-dc4asv5","policy":null}],"workload":{"name":"azure-ubuntu","policy":{"pcrs.0":false}},"metadata":null}

namestringrequired

Name of the policy

Responses

application/json

objectoptional

put

PUT /v1/auth/ratls/policies HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "created": 1,
  "identities": {},
  "name": "text"
}

200

{
  "auth": {},
  "data": {
    "created": 1,
    "identities": {},
    "name": "text"
  }
}

Update policy

post

Body

createdinteger · int64required

Creation timestamp, set by the plugin

identitiesobject · maprequired

A map of all identity types with their respective selector

Default:

{"provider":"azure-sev-snp-vtpm","platform":null,"firmware":[{"name":"azure-dc2asv5","policy":null},{"name":"azure-dc4asv5","policy":null}],"workload":{"name":"azure-ubuntu","policy":{"pcrs.0":false}},"metadata":null}

namestringrequired

Name of the policy

Responses

application/json

objectoptional

post

POST /v1/auth/ratls/policies HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "created": 1,
  "identities": {},
  "name": "text"
}

200

{
  "auth": {},
  "data": {
    "created": 1,
    "identities": {},
    "name": "text"
  }
}