Credentials

Credential management operations

List credentials

get

Lists all credentials, optionally filtered by user_id or type

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Query parameters
user_idstringOptional

Filter by user ID

typestringOptional

Filter by credential type

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Responses
200

Credentials listed successfully

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

Create credential

post

Creates a credential

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

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

{
  "credential": {
    "user_id": "text",
    "project_id": "text",
    "type": "text",
    "blob": "text"
  }
}
{
  "credential": {
    "id": "text",
    "user_id": "text",
    "project_id": "text",
    "type": "text",
    "blob": "text",
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Show credential details

get

Shows details for a credential

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
credential_idstringRequired

The credential ID

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Responses
200

Credential details retrieved successfully

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

Delete credential

delete

Deletes a credential

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
credential_idstringRequired

The credential ID

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

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

No content

Update credential

patch

Updates a credential

Authorizations
X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Path parameters
credential_idstringRequired

The credential ID

Header parameters
X-Auth-TokenstringRequired

A valid authentication token

Body
Responses
200

Credential updated successfully

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

{
  "credential": {
    "user_id": "text",
    "project_id": "text",
    "type": "text",
    "blob": "text"
  }
}
{
  "credential": {
    "id": "text",
    "user_id": "text",
    "project_id": "text",
    "type": "text",
    "blob": "text",
    "links": {
      "self": "text",
      "previous": "text",
      "next": "text"
    }
  }
}

Last updated

Was this helpful?