Identities

Create identity

put

Creates a new identity record

Body

application/json

createdinteger · int64Required

Creation timestamp, set by the plugin

namestringRequired

Name of the identity

typestringRequired

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

valuesobject · mapRequired

Values for the identity

Default: {}

Responses

200

Identity created successfully

application/json

400

Invalid request body

put

/v1/auth/ratls/identities

HTTPcURLJavaScriptPython

PUT /v1/auth/ratls/identities HTTP/1.1
Host: localhost:8200
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "created": 1,
  "name": "text",
  "type": "text",
  "values": {}
}

{
  "auth": {},
  "data": {
    "created": 1,
    "name": "text",
    "type": "text",
    "values": {}
  }
}

List all identities

get

Retrieves a list of all identity records

Query parameters

liststring · enumRequired

Must be set to 'true' to retrieve the list

Possible values:

Responses

200

Identity list retrieved successfully

application/json

get

/v1/auth/ratls/identities/

HTTPcURLJavaScriptPython

GET /v1/auth/ratls/identities/?list=true HTTP/1.1
Host: localhost:8200
Accept: */*

200

Identity list retrieved successfully

{
  "request_id": "text",
  "lease_id": "text",
  "renewable": true,
  "lease_duration": 1,
  "data": {
    "keys": [
      "text"
    ]
  },
  "wrap_info": null,
  "warnings": null,
  "auth": null
}

List identities by type

get

Retrieves a list of identities filtered by type

Path parameters

typestring · enumRequired

Identity type (platform, firmware, workload, metadata)

Possible values:

Query parameters

liststring · enumRequired

Must be set to 'true' to retrieve the list

Possible values:

Responses

200

Identity list retrieved successfully

application/json

get

/v1/auth/ratls/identities/{type}/

HTTPcURLJavaScriptPython

GET /v1/auth/ratls/identities/{type}/?list=true HTTP/1.1
Host: localhost:8200
Accept: */*

200

Identity list retrieved successfully

{
  "request_id": "text",
  "lease_id": "text",
  "renewable": true,
  "lease_duration": 1,
  "data": {
    "keys": [
      "text"
    ]
  },
  "wrap_info": null,
  "warnings": null,
  "auth": null
}

List identities by type and name

get

Retrieves a list of identities filtered by type and name

Path parameters

typestring · enumRequired

Identity type (platform, firmware, workload, metadata)

Possible values:

namestringRequired

Identity name

Query parameters

liststring · enumRequired

Must be set to 'true' to retrieve the list

Possible values:

Responses

200

Identity list retrieved successfully

application/json

get

/v1/auth/ratls/identities/{type}/{name}/

HTTPcURLJavaScriptPython

GET /v1/auth/ratls/identities/{type}/{name}/?list=true HTTP/1.1
Host: localhost:8200
Accept: */*

200

Identity list retrieved successfully

{
  "request_id": "text",
  "lease_id": "text",
  "renewable": true,
  "lease_duration": 1,
  "data": {
    "keys": [
      "text"
    ]
  },
  "wrap_info": null,
  "warnings": null,
  "auth": null
}

Get identity details

get

Retrieves detailed information about a specific identity

Path parameters

typestring · enumRequired

Identity type (platform, firmware, workload, metadata)

Possible values:

namestringRequired

Identity name

createdinteger · int64Required

Creation timestamp

Responses

200

Identity details retrieved successfully

application/json

400

Identity not found

get

/v1/auth/ratls/identities/{type}/{name}/{created}

HTTPcURLJavaScriptPython

GET /v1/auth/ratls/identities/{type}/{name}/{created} HTTP/1.1
Host: localhost:8200
Accept: */*

{
  "auth": {},
  "data": {
    "created": 1,
    "name": "text",
    "type": "text",
    "values": {}
  }
}

Delete identity

delete

Removes a specific identity record

Path parameters

typestring · enumRequired

Identity type (platform, firmware, workload, metadata)

Possible values:

namestringRequired

Identity name

createdinteger · int64Required

Creation timestamp

Responses

200

Identity deleted successfully

No content

400

Identity not found

delete

/v1/auth/ratls/identities/{type}/{name}/{created}

HTTPcURLJavaScriptPython

DELETE /v1/auth/ratls/identities/{type}/{name}/{created} HTTP/1.1
Host: localhost:8200
Accept: */*

No content