Get personal dashboard
GET/api/admin/personal-dashboard
Return all projects and flags that are relevant to the user.
Responses
- 200
- 401
- 403
- 404
personalDashboardSchema
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Array [
]
Array [
]
Array [
]
admins
object[]
required
Users with the admin role in Unleash.
The user ID.
1
The user's name.
Ash Ketchum
The user's username.
pokémaster13
https://example.com/peek-at-you.jpg
user@example.com
projectOwners
object[]
required
Users with the project owner role in Unleash. Only contains owners of projects that are visible to the user.
The type of the owner; will always be user
.
Possible values: [user
]
The name displayed for the user. Can be the user's name, username, or email, depending on what they have provided.
User Name
The URL of the user's profile image.
https://example.com/image.jpg
The user's email address.
user@example.com
projects
object[]
required
A list of projects that a user participates in with any role e.g. member or owner or any custom role
The id of the project
my-project-id
The name of the project
My Project
The number of members this project has
4
The number of features this project has
10
flags
object[]
required
A list of flags a user created or favorited
The name of the flag
my-flag
The id of the feature project
my-project-id
The type of the feature flag
release
{
"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
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
AuthenticationRequired
A description of what went wrong.
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.
{
"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
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NoAccessError
A description of what went wrong.
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"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
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NotFoundError
A description of what went wrong.
Could not find the addon with ID "12345".
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}