Nitride
HomeDocumentationTutorials
  • Nitride
  • Documentation
    • What is Nitride?
    • Use Cases
    • Setup
      • Install Nitride
      • Configure
    • Get Started
      • Attesting a MariaDB database with Cloud-Init
    • Concepts
      • Attestation
        • AMD SEV PKI
        • Intel TDX PKI
      • enclaivelet
    • Supported Technologies
  • Tutorials
    • Create identities and policies
    • Attesting a buckypaper VM
  • Developers
    • API
      • Overview
      • Identities
      • Policies
      • Totp
      • Attestations
      • Logs
      • Config
      • Annotations
  • CLI
    • Enable Auth
    • Register Identities
    • Create Policy
    • Create Attestation
    • Enable Namespacing
  • Resources
    • Blog
    • GitHub
    • Youtube
    • CCx101
Powered by GitBook
On this page

Was this helpful?

  1. Developers
  2. API

Identities

Last updated 4 months ago

Was this helpful?

Create identities

List identities for type

get
Path parameters
typestringRequired

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

Query parameters
liststring · enumRequired

Must be set to true

Possible values:
Responses
200
OK
application/json
get
GET /v1/auth/ratls/identities/{type}/?list=true HTTP/1.1
Host: 
Accept: */*
200

OK

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

List identities for type and name

get
Path parameters
namestringRequired

Name of the identity

typestringRequired

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

Query parameters
liststring · enumRequired

Must be set to true

Possible values:
Responses
200
OK
application/json
get
GET /v1/auth/ratls/identities/{type}/{name}/?list=true HTTP/1.1
Host: 
Accept: */*
200

OK

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

Read identity

get
Path parameters
createdintegerRequired

Creation timestamp, set by the plugin

namestringRequired

Name of the identity

typestringRequired

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

Responses
200
OK
application/json
get
GET /v1/auth/ratls/identities/{type}/{name}/{created} HTTP/1.1
Host: 
Accept: */*
200

OK

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

Delete identity

delete
Path parameters
createdintegerRequired

Creation timestamp, set by the plugin

namestringRequired

Name of the identity

typestringRequired

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

Responses
200
OK
delete
DELETE /v1/auth/ratls/identities/{type}/{name}/{created} HTTP/1.1
Host: 
Accept: */*
200

OK

No content

  • Create identities
  • PUTCreate identity
  • GETList identities
  • GETList identities for type
  • GETList identities for type and name
  • GETRead identity
  • DELETEDelete identity

List identities

get
Query parameters
liststring · enumRequired

Must be set to true

Possible values:
Responses
200
OK
application/json
get
GET /v1/auth/ratls/identities/?list=true HTTP/1.1
Host: 
Accept: */*
200

OK

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

Create identity

put
Body
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
OK
application/json
put
PUT /v1/auth/ratls/identities HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 53

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

OK

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