Credentials

Credential management operations

List credentials

get

Lists all credentials, optionally filtered by user_id or type

Authorizations

ApiKeyAuth

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

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

get

/credentials

HTTPcURLJavaScriptPython

GET /keystone/v3/credentials HTTP/1.1
Host: example.platform9.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

ApiKeyAuth

X-Auth-TokenstringRequired

Authentication token obtained from the authentication service

Header parameters

X-Auth-TokenstringRequired

A valid authentication token

Body

application/json

Responses

201

Credential created successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

409

This operation conflicted with another operation on this resource

application/json

post

/credentials

HTTPcURLJavaScriptPython

POST /keystone/v3/credentials HTTP/1.1
Host: example.platform9.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

ApiKeyAuth

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

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

get

/credentials/{credential_id}

HTTPcURLJavaScriptPython

GET /keystone/v3/credentials/{credential_id} HTTP/1.1
Host: example.platform9.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

ApiKeyAuth

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

204

Credential deleted successfully

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

409

This operation conflicted with another operation on this resource

application/json

delete

/credentials/{credential_id}

HTTPcURLJavaScriptPython

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

No content

Update credential

patch

Updates a credential

Authorizations

ApiKeyAuth

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

application/json

Responses

200

Credential updated successfully

application/json

400

Some content in the request was invalid

application/json

401

User must authenticate before making a request

application/json

403

Policy does not allow current user to do this operation

application/json

404

The requested resource could not be found

application/json

409

This operation conflicted with another operation on this resource

application/json

patch

/credentials/{credential_id}

HTTPcURLJavaScriptPython

PATCH /keystone/v3/credentials/{credential_id} HTTP/1.1
Host: example.platform9.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"
    }
  }
}