Create API key

POST /users/auth/keys

Auth

Creates a new API key.

Request body

The request to create the API key

description string required: API key description. Useful if there are multiple keys
expiration string: The optional expiration for the API key, provided as a duration (ex: '1d', '3h')
role_assignments object: Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.

Responses

The API key is created and returned in the body of the response.

application/json

id string required: The API key ID.
user_id string: The user ID.
organization_id string: The organization ID linked to the API key
description string required: The API key description. TIP: Useful when you have multiple API keys.
key string: The API key. TIP: Since the API key is returned only once, save it in a safe place.
creation_date string · format: date-time required: The date/time for when the API key is created.
expiration_date string · format: date-time: The date/time when the API key expires.
role_assignments object: Roles assigned to users, API keys or organization invitations. Currently unavailable in self-hosted ECE.; Same fields as role_assignments

The request is invalid. Specify a different request, then try again. (code: api_keys.invalid_input)

application/json

Examples

Request curl 1 / 1 language

curl Shell

curl -X POST "${API_URL}/users/auth/keys" \
  -u "${USERNAME}:${PASSWORD}" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string"
  }'

Generated from the API spec

Response

{
  "id": "string",
  "user_id": "string",
  "organization_id": "string",
  "description": "string",
  "key": "string",
  "creation_date": "string",
  "expiration_date": "string",
  "role_assignments": {
    "platform": [
      {
        "role_id": "string"
      }
    ],
    "organization": [
      {
        "role_id": "string",
        "organization_id": "string",
        "application_roles": [
          "string"
        ]
      }
    ],
    "deployment": [
      {
        "role_id": "string",
        "organization_id": "string",
        "all": false,
        "deployment_ids": [
          "string"
        ],
        "application_roles": [
          "string"
        ]
      }
    ],
    "project": {
      "elasticsearch": [
        {
          "role_id": "string",
          "organization_id": "string",
          "all": false,
          "project_ids": [
            "string"
          ],
          "application_roles": [
            "string"
          ]
        }
      ],
      "observability": [
        {
          "role_id": "string",
          "organization_id": "string",
          "all": false,
          "project_ids": [
            "string"
          ],
          "application_roles": [
            "string"
          ]
        }
      ],
      "security": [
        {
          "role_id": "string",
          "organization_id": "string",
          "all": false,
          "project_ids": [
            "string"
          ],
          "application_roles": [
            "string"
          ]
        }
      ],
      "workplaceai": [
        {
          "role_id": "string",
          "organization_id": "string",
          "all": false,
          "project_ids": [
            "string"
          ],
          "application_roles": [
            "string"
          ]
        }
      ],
      "vectordb": [
        {
          "role_id": "string",
          "organization_id": "string",
          "all": false,
          "project_ids": [
            "string"
          ],
          "application_roles": [
            "string"
          ]
        }
      ]
    }
  }
}

Generated from the API spec

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Generated from the API spec