Home
DocumentationTutorials

Identities

Create identity

PUT/v1/auth/ratls/identities
Body
created*integer (int64)

Creation timestamp, set by the plugin

name*string

Name of the identity

type*string

Type of the identity, available: platform, firmware, workload, metadata

values*object (map)

Values for the identity

Response

OK

Body
authobject
dataobject
Request
const response = await fetch('/v1/auth/ratls/identities', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "created": 0,
      "name": "text",
      "type": "text"
    }),
});
const data = await response.json();
Response
{
  "data": {
    "created": 0,
    "name": "text",
    "type": "text"
  }
}

List identities

GET/v1/auth/ratls/identities/
Query parameters
Response

OK

Body
authobject
dataobject
Request
const response = await fetch('/v1/auth/ratls/identities/?list=true', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": {
    "keys": []
  }
}

List identities for type

GET/v1/auth/ratls/identities/{type}/
Path parameters
type*string

Type of the identity, available: platform, firmware, workload, metadata

Query parameters
Response

OK

Body
authobject
dataobject
Request
const response = await fetch('/v1/auth/ratls/identities/{type}/?list=true', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": {
    "keys": []
  }
}

List identities for type and name

GET/v1/auth/ratls/identities/{type}/{name}/
Path parameters
name*string

Name of the identity

type*string

Type of the identity, available: platform, firmware, workload, metadata

Query parameters
Response

OK

Body
authobject
dataobject
Request
const response = await fetch('/v1/auth/ratls/identities/{type}/{name}/?list=true', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": {
    "keys": []
  }
}

Read identity

GET/v1/auth/ratls/identities/{type}/{name}/{created}
Path parameters
created*integer

Creation timestamp, set by the plugin

name*string

Name of the identity

type*string

Type of the identity, available: platform, firmware, workload, metadata

Response

OK

Body
authobject
dataobject
Request
const response = await fetch('/v1/auth/ratls/identities/{type}/{name}/{created}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "data": {
    "created": 0,
    "name": "text",
    "type": "text"
  }
}

Delete identity

DELETE/v1/auth/ratls/identities/{type}/{name}/{created}
Path parameters
created*integer

Creation timestamp, set by the plugin

name*string

Name of the identity

type*string

Type of the identity, available: platform, firmware, workload, metadata

Response

empty body

Request
const response = await fetch('/v1/auth/ratls/identities/{type}/{name}/{created}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Last updated