Get personal dashboard

GET /api/admin/personal-dashboard

Return all projects and flags that are relevant to the user.

Request

Responses

• 200
• 401
• 403
• 404

---

personalDashboardSchema

application/json

Schema

Schema

• admins object[]required

  Users with the admin role in Unleash.

  Array [

  id integer required

  The user ID.

  name string

  The user's name.

  username string

  The user's username.

  imageUrl string

  email string

  ]
• projectOwners object[]required

  Users with the project owner role in Unleash. Only contains owners of projects that are visible to the user.

  Array [

  ownerType string required

  Possible values: [user]

  The type of the owner; will always be user.

  name string required

  The name displayed for the user. Can be the user's name, username, or email, depending on what they have provided.

  imageUrl string nullable

  The URL of the user's profile image.

  email string nullable

  The user's email address.

  ]
• projects object[]required

  A list of projects that a user participates in with any role e.g. member or owner or any custom role

  Array [

  id string required

  The id of the project

  name string required

  The name of the project

  health number required

  An indicator of the project's health on a scale from 0 to 100

  memberCount number required

  The number of members this project has

  featureCount number required

  The number of features this project has

  ]
• flags object[]required

  A list of flags a user created or favorited

  Array [

  name string required

  The name of the flag

  project string required

  The id of the feature project

  type string required

  The type of the feature flag

  ]

Example (from schema)

{
  "admins": [
    {
      "id": 1,
      "name": "Ash Ketchum",
      "username": "pokémaster13",
      "imageUrl": "https://example.com/peek-at-you.jpg",
      "email": "user@example.com"
    }
  ],
  "projectOwners": [
    {
      "ownerType": "user",
      "name": "User Name",
      "imageUrl": "https://example.com/image.jpg",
      "email": "user@example.com"
    }
  ],
  "projects": [
    {
      "id": "my-project-id",
      "name": "My Project",
      "health": 50,
      "memberCount": 4,
      "featureCount": 10
    }
  ],
  "flags": [
    {
      "name": "my-flag",
      "project": "my-project-id",
      "type": "release"
    }
  ]
}

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

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

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": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

The requested resource was not found.

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": "NotFoundError",
  "message": "Could not find the addon with ID \"12345\"."
}

Loading...