Skip to main content
GET
/
users
/
auth
/
keys
Get all API keys
curl --request GET \
  --url https://api.elastic-cloud.com/api/v1/users/auth/keys \
  --header 'Authorization: <api-key>'
{
  "keys": [
    {
      "creation_date": "<dateTime>",
      "description": "<string>",
      "expiration_date": "<dateTime>",
      "id": "<string>",
      "key": "<string>",
      "organization_id": "<string>",
      "role_assignments": {
        "deployment": [
          {
            "all": "<boolean>",
            "application_roles": [
              "<string>",
              "<string>"
            ],
            "deployment_ids": [
              "<string>",
              "<string>"
            ],
            "organization_id": "<string>",
            "role_id": "<string>"
          },
          {
            "all": "<boolean>",
            "application_roles": [
              "<string>",
              "<string>"
            ],
            "deployment_ids": [
              "<string>",
              "<string>"
            ],
            "organization_id": "<string>",
            "role_id": "<string>"
          }
        ],
        "organization": [
          {
            "organization_id": "<string>",
            "role_id": "<string>"
          },
          {
            "organization_id": "<string>",
            "role_id": "<string>"
          }
        ],
        "platform": [
          {
            "role_id": "<string>"
          },
          {
            "role_id": "<string>"
          }
        ],
        "project": {
          "elasticsearch": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ],
          "observability": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ],
          "security": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ]
        }
      },
      "user_id": "<string>"
    },
    {
      "creation_date": "<dateTime>",
      "description": "<string>",
      "expiration_date": "<dateTime>",
      "id": "<string>",
      "key": "<string>",
      "organization_id": "<string>",
      "role_assignments": {
        "deployment": [
          {
            "all": "<boolean>",
            "application_roles": [
              "<string>",
              "<string>"
            ],
            "deployment_ids": [
              "<string>",
              "<string>"
            ],
            "organization_id": "<string>",
            "role_id": "<string>"
          },
          {
            "all": "<boolean>",
            "application_roles": [
              "<string>",
              "<string>"
            ],
            "deployment_ids": [
              "<string>",
              "<string>"
            ],
            "organization_id": "<string>",
            "role_id": "<string>"
          }
        ],
        "organization": [
          {
            "organization_id": "<string>",
            "role_id": "<string>"
          },
          {
            "organization_id": "<string>",
            "role_id": "<string>"
          }
        ],
        "platform": [
          {
            "role_id": "<string>"
          },
          {
            "role_id": "<string>"
          }
        ],
        "project": {
          "elasticsearch": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ],
          "observability": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ],
          "security": [
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            },
            {
              "all": "<boolean>",
              "application_roles": [
                "<string>",
                "<string>"
              ],
              "organization_id": "<string>",
              "project_ids": [
                "<string>",
                "<string>"
              ],
              "role_id": "<string>"
            }
          ]
        }
      },
      "user_id": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Response

200 - application/json

The metadata for the API keys is retrieved.

keys
object[]
Example:
[
{
"creation_date": "<dateTime>",
"description": "<string>",
"expiration_date": "<dateTime>",
"id": "<string>",
"key": "<string>",
"organization_id": "<string>",
"role_assignments": {
"deployment": [
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"deployment_ids": ["<string>", "<string>"],
"organization_id": "<string>",
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"deployment_ids": ["<string>", "<string>"],
"organization_id": "<string>",
"role_id": "<string>"
}
],
"organization": [
{
"organization_id": "<string>",
"role_id": "<string>"
},
{
"organization_id": "<string>",
"role_id": "<string>"
}
],
"platform": [
{ "role_id": "<string>" },
{ "role_id": "<string>" }
],
"project": {
"elasticsearch": [
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
}
],
"observability": [
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
}
],
"security": [
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
}
]
}
},
"user_id": "<string>"
},
{
"creation_date": "<dateTime>",
"description": "<string>",
"expiration_date": "<dateTime>",
"id": "<string>",
"key": "<string>",
"organization_id": "<string>",
"role_assignments": {
"deployment": [
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"deployment_ids": ["<string>", "<string>"],
"organization_id": "<string>",
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"deployment_ids": ["<string>", "<string>"],
"organization_id": "<string>",
"role_id": "<string>"
}
],
"organization": [
{
"organization_id": "<string>",
"role_id": "<string>"
},
{
"organization_id": "<string>",
"role_id": "<string>"
}
],
"platform": [
{ "role_id": "<string>" },
{ "role_id": "<string>" }
],
"project": {
"elasticsearch": [
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
}
],
"observability": [
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
}
],
"security": [
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
},
{
"all": "<boolean>",
"application_roles": ["<string>", "<string>"],
"organization_id": "<string>",
"project_ids": ["<string>", "<string>"],
"role_id": "<string>"
}
]
}
},
"user_id": "<string>"
}
]
I