Path parameters

• uid string | array[string] Required

  A unique identifier for the user profile.

Query parameters

• data string | array[string]

  A comma-separated list of filters for the data field of the profile document. To return all content use data=*. To return a subset of content use data=<key> to retrieve content nested under the specified <key>. By default returns no data content.

Responses

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

  • profiles array[object] Required

    A successful call returns the JSON representation of the user profile and its internal versioning numbers. The API returns an empty object if no profile document is found for the provided uid. The content of the data field is not returned by default to avoid deserializing a potential large payload.

    Hide profiles attributes Show profiles attributes object

    • uid string Required
    • user object Required
      Hide user attributes Show user attributes object

      • email string | null

        One of:

        string-1 string string-2 string | null

      • full_name string | null

        One of:

        Name string string-2 string | null
      • realm_name string Required
      • realm_domain string
      • roles array[string] Required
      • username string Required
    • data object Required
      Hide data attribute Show data attribute object

      • * object Additional properties
    • labels object Required
      Hide labels attribute Show labels attribute object

      • * object Additional properties
    • enabled boolean
    • last_synchronized number Required
    • _doc object Required
      Hide _doc attributes Show _doc attributes object

      • _primary_term number Required
      • _seq_no number Required
  • errors object
    Hide errors attributes Show errors attributes object

    • count number Required
    • details object Required
      Hide details attribute Show details attribute object

      • * object

        Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        Hide * attributes Show * attributes object

        • type string Required

          The type of error

        • reason string | null

          A human-readable explanation of the error, in English.

          One of:

          string-1 string string-2 string | null
        • stack_trace string

          The server stack trace. Present only if the error_trace=true parameter was sent with the request.

        • caused_by object

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • root_cause array[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

        • suppressed array[object]

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.

          Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.