Get personal project details

GET /api/admin/personal-dashboard/:projectId

Return personal dashboard project events, owners, user roles and onboarding status

Request

Path Parameters

• projectId string required

Responses

• 200
• 401
• 403
• 404

---

personalDashboardProjectDetailsSchema

application/json

Schema

Schema

• onboardingStatus objectrequired

  The current onboarding status of the project.

  oneOf

  MOD1

  status string required

  Possible values: [onboarding-started, onboarded]

  MOD2

  status string required

  Possible values: [first-flag-created]

  feature string required

  The name of the feature flag

• latestEvents object[]required

  The latest events for the project.

  Array [

  id integer required

  Possible values: >= 1

  The ID of the event.

  summary string nullable required

  [Experimental] A markdown-formatted summary of the event.

  createdBy string required

  Which user created this event

  createdByImageUrl string required

  URL used for the user profile image of the event author

  ]
• owners objectrequired

  The users and/or groups that have the "owner" role in this project. If no such users or groups exist, the list will contain the "system" owner instead.

  oneOf

  MOD1

  Array [

  anyOf

  MOD1

  ownerType string required

  Possible values: [user]

  name string required

  imageUrl string nullable

  email string nullable

  MOD2

  ownerType string required

  Possible values: [group]

  name string required

  ]

  MOD2

  Array [

  ownerType string required

  Possible values: [system]

  ]
• roles object[]required

  Possible values: >= 1

  The list of roles that the user has in this project.

  Array [

  name string required

  The name of the role

  id integer required

  The id of the role

  type string required

  Possible values: [custom, project, root, custom-root]

  The type of the role

  ]

Example (from schema)

{
  "onboardingStatus": {},
  "latestEvents": [
    {
      "id": 0,
      "summary": "string",
      "createdBy": "johndoe",
      "createdByImageUrl": "https://example.com/242x200.png"
    }
  ],
  "owners": [
    null
  ],
  "roles": [
    {
      "name": "Owner",
      "id": 4,
      "type": "project"
    }
  ]
}

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