Responses

• 200 application/json
  Hide response attributes Show response attributes object

  • api_key object
    Hide api_key attributes Show api_key attributes object

    • creation number

      Creation time for the API key in milliseconds.

    • expiration number

      Expiration time for the API key in milliseconds.

    • id string Required
    • invalidated boolean

      Invalidation status for the API key. If the key has been invalidated, it has a value of true. Otherwise, it is false.

    • name string Required
    • realm string

      Realm name of the principal for which this API key was created.

    • realm_type string

      Realm type of the principal for which this API key was created

    • username string
    • profile_uid string

      The profile uid for the API key owner principal, if requested and if it exists

    • metadata object
      Hide metadata attributes Show metadata attributes object

      • Additional properties
      • key object
    • role_descriptors object
      Hide role_descriptors attributes Show role_descriptors attributes object

      • Additional properties
      • cluster array[string]

        A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.

      • indices array[object]

        A list of indices permissions entries.

        Hide indices attributes Show indices attributes object

        • field_security object
        • names string | array[string] Required
        • privileges array[string] Required

          The index level privileges that owners of the role have on the specified indices.

        • query
      • applications array[object]

        A list of application privilege entries

        Hide applications attributes Show applications attributes object

        • application string Required

          The name of the application to which this entry applies.

        • privileges array[string] Required

          A list of strings, where each element is the name of an application privilege or action.

        • resources array[string] Required

          A list resources to which the privileges are applied.

      • metadata object
        Hide metadata attributes Show metadata attributes object

        • Additional properties
        • key object
      • run_as array[string]

        A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected.

      • description string

        Optional description of the role descriptor

      • transient_metadata object
        Hide transient_metadata attributes Show transient_metadata attributes object

        • Additional properties
        • key object
    • limited_by array[object]

      The owner user’s permissions associated with the API key. It is a point-in-time snapshot captured at creation and subsequent updates. An API key’s effective permissions are an intersection of its assigned privileges and the owner user’s permissions.

      Hide limited_by attributes Show limited_by attributes object

      • Additional properties
      • cluster array[string]

        A list of cluster privileges. These privileges define the cluster level actions that API keys are able to execute.

      • indices array[object]

        A list of indices permissions entries.
      • applications array[object]

        A list of application privilege entries
      • metadata object
        Hide metadata attributes Show metadata attributes object

        • Additional properties
        • key object
      • run_as array[string]

        A list of users that the API keys can impersonate. Note: in Serverless, the run-as feature is disabled. For API compatibility, you can still specify an empty run_as field, but a non-empty list will be rejected.

      • description string

        Optional description of the role descriptor

      • transient_metadata object
        Hide transient_metadata attributes Show transient_metadata attributes object

        • Additional properties
        • key object
    • _sort array[number | string | boolean | null | object]

      A field value.

      One of:

      _types:FieldValue number _types:FieldValue number _types:FieldValue string _types:FieldValue boolean _types:FieldValue string | null _types:FieldValue object
  • authentication_realm object Required
    Hide authentication_realm attributes Show authentication_realm attributes object

    • name string Required
    • type string Required

  • email string | null

    One of:

    string-1 string string-2 string | null

  • full_name string | null

    One of:

    _types:Name string string-2 string | null
  • lookup_realm object Required
    Hide lookup_realm attributes Show lookup_realm attributes object

    • name string Required
    • type string Required
  • metadata object Required
    Hide metadata attributes Show metadata attributes object

    • Additional properties
    • key object
  • roles array[string] Required
  • username string Required
  • enabled boolean Required
  • authentication_type string Required
  • token object
    Hide token attributes Show token attributes object

    • name string Required
    • type string