Get personal dashboard
GET <your-unleash-url>/api/admin/personal-dashboard
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Return all projects and flags that are relevant to the user.
Request
Responses
- 200
- 401
- 403
- 404
personalDashboardSchema
- application/json
- Schema
- Example (from schema)
Schema
admins object[]required
projectOwners object[]required
projects object[]required
flags object[]required
{
"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
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"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
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"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
- id string
The ID of the error instance
- name string
The name of the error kind
- message string
A description of what went wrong.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NotFoundError",
"message": "Could not find the addon with ID \"12345\"."
}
Authorization
name: Authorizationtype: apiKeyin: headerdescription: API key needed to access this API
Request
Request
curl / cURL
curl -L -X GET '<your-unleash-url>/api/admin/personal-dashboard' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
python / requests
curl -L -X GET '<your-unleash-url>/api/admin/personal-dashboard' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
go / native
curl -L -X GET '<your-unleash-url>/api/admin/personal-dashboard' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
nodejs / native
curl -L -X GET '<your-unleash-url>/api/admin/personal-dashboard' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
ruby / Net::HTTP
curl -L -X GET '<your-unleash-url>/api/admin/personal-dashboard' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
csharp / httpclient
curl -L -X GET '<your-unleash-url>/api/admin/personal-dashboard' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
php / cURL
curl -L -X GET '<your-unleash-url>/api/admin/personal-dashboard' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
java / OkHttp
curl -L -X GET '<your-unleash-url>/api/admin/personal-dashboard' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'
powershell / RestMethod
curl -L -X GET '<your-unleash-url>/api/admin/personal-dashboard' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'