Get your own user details

GET 
/api/admin/user

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

Responses

200

meSchema

application/json

Schema

Schema

user

object

required

An Unleash user

id integerrequired

The user id

Example: 123

isAPI booleandeprecated

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

Example: true

name stringnullable

Name of the user

Example: User

email string

Email of the user

Example: user@example.com

username stringnullable

A unique username for the user

Example: hunter

imageUrl string

URL used for the user profile image

Example: https://example.com/242x200.png

inviteLink string

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

Example: http://localhost:4242/invite-link/some-secret

loginAttempts integer

How many unsuccessful attempts at logging in has the user made

Example: 3

emailSent boolean

Is the welcome email sent to the user or not

Example: false

rootRole integer

Which root role this user is assigned

Example: 1

seenAt date-timenullable

The last time this user logged in

Example: 2023-06-30T11:42:00.345Z

createdAt date-time

The user was created at this time

Example: 2023-06-30T11:41:00.123Z

accountType string

A user is either an actual User or a Service Account

Example: User

permissions string[]

Deprecated

scimId stringnullable

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

Example: 01HTMEXAMPLESCIMID7SWWGHN6

permissions

object[]

required

User permissions for projects and environments

Array [

permission stringrequired

Project or environment permission name

Example: UPDATE_FEATURE_STRATEGY

project string

The project this permission applies to

Example: my-project

environment string

The environment this permission applies to

Example: development

]

feedback

object[]

required

User feedback information

Array [

userId integer

The ID of the user that gave the feedback.

Example: 2

neverShow boolean

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

Example: false

given date-timenullable

When this feedback was given

Example: 2023-07-06T08:29:21.282Z

feedbackId string

The name of the feedback session

Example: pnps

]

splash

object

required

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": {}
}

401

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
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: 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.

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."
}

Loading...