Get users

GET /_security/user

Get information about users in the native realm and built-in users.

Query parameters

with_profile_uid boolean

If true will return the User Profile ID for a user, if any.

Responses

200 application/json
Hide response attribute Show response attribute object
- * object Additional properties
  
  Additional properties are allowed.
  
  Hide * attributes Show * attributes object
  
  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
  
  metadata object Required
  
  Hide metadata attribute Show metadata attribute object
  
  * object Additional properties
  
  Additional properties are allowed.
  
  roles array[string] Required
  
  username string Required
  
  enabled boolean Required
  
  profile_uid string

GET /_security/user

curl \
 -X GET http://api.example.com/_security/user

Response examples (200)

{
  "additionalProperty1": {
    "email": "string",
    "full_name": "string",
    "metadata": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    },
    "roles": [
      "string"
    ],
    "username": "string",
    "enabled": true,
    "profile_uid": "string"
  },
  "additionalProperty2": {
    "email": "string",
    "full_name": "string",
    "metadata": {
      "additionalProperty1": {},
      "additionalProperty2": {}
    },
    "roles": [
      "string"
    ],
    "username": "string",
    "enabled": true,
    "profile_uid": "string"
  }
}

Get users

Query parameters

Responses

email string | null

full_name string | null