Get your own user details

GET <your-unleash-url>/api/admin/user

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Detailed information about the current user, user permissions and user feedback

Request

Responses

• 200
• 401

---

meSchema

application/json

Schema

Schema

• user objectrequired

  An Unleash user

  id integer required

  The user id

  isAPI boolean deprecated

  Deprecated in v5. Used internally to know which operations the user should be allowed to perform

  name string nullable

  Name of the user

  email string

  Email of the user

  username string nullable

  A unique username for the user

  imageUrl string

  URL used for the userprofile image

  inviteLink string

  If the user is actively inviting other users, this is the link that can be shared with other users

  loginAttempts integer

  How many unsuccessful attempts at logging in has the user made

  emailSent boolean

  Is the welcome email sent to the user or not

  rootRole integer

  Which root role this user is assigned

  seenAt date-time nullable

  The last time this user logged in

  createdAt date-time

  The user was created at this time

  accountType string

  A user is either an actual User or a Service Account

  permissions string[]

  Deprecated

  scimId string nullable

  The SCIM ID of the user, only present if managed by SCIM

• permissions object[]required

  User permissions for projects and environments

  Array [

  permission string required

  Project or environment permission name

  project string

  The project this permission applies to

  environment string

  The environment this permission applies to

  ]
• feedback object[]required

  User feedback information

  Array [

  userId integer

  The ID of the user that gave the feedback.

  neverShow boolean

  true if the user has asked never to see this feedback questionnaire again.

  given date-time nullable

  When this feedback was given

  feedbackId string

  The name of the feedback session

  ]
• splash objectrequired

  Splash screen configuration

  property name* boolean

Example (from schema)

{
  "user": {
    "id": 123,
    "name": "User",
    "email": "user@example.com",
    "username": "hunter",
    "imageUrl": "https://example.com/242x200.png",
    "inviteLink": "http://localhost:4242/invite-link/some-secret",
    "loginAttempts": 3,
    "emailSent": false,
    "rootRole": 1,
    "seenAt": "2023-06-30T11:42:00.345Z",
    "createdAt": "2023-06-30T11:41:00.123Z",
    "accountType": "User",
    "permissions": [
      "string"
    ],
    "scimId": "01HTMEXAMPLESCIMID7SWWGHN6"
  },
  "permissions": [
    {
      "permission": "UPDATE_FEATURE_STRATEGY",
      "project": "my-project",
      "environment": "development"
    }
  ],
  "feedback": [
    {
      "userId": 2,
      "neverShow": false,
      "given": "2023-07-06T08:29:21.282Z",
      "feedbackId": "pnps"
    }
  ],
  "splash": {}
}

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

• id string

  The ID of the error instance

• name string

  The name of the error kind

• message string

  A description of what went wrong.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

Authorization

name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API

Request

Base URL

<your-unleash-url>

Security Scheme

apiKeybearerToken

apiKey

curl / cURL

curl -L -X GET '<your-unleash-url>/api/admin/user' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

python / requests

curl -L -X GET '<your-unleash-url>/api/admin/user' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

go / native

curl -L -X GET '<your-unleash-url>/api/admin/user' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

nodejs / native

curl -L -X GET '<your-unleash-url>/api/admin/user' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

ruby / Net::HTTP

curl -L -X GET '<your-unleash-url>/api/admin/user' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

csharp / httpclient

curl -L -X GET '<your-unleash-url>/api/admin/user' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

php / cURL

curl -L -X GET '<your-unleash-url>/api/admin/user' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

java / OkHttp

curl -L -X GET '<your-unleash-url>/api/admin/user' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

powershell / RestMethod

curl -L -X GET '<your-unleash-url>/api/admin/user' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'