1. Docs
  2. API Reference
  3. Resolve the current user's product access and landing

Resolve the current user's product access and landing

GET/portal/v1/accounts/{accountSlug}/me/landing

Where the signed-in user should land in this Account after sign-in, and why. access_modes.console is granted when they hold console.access. access_modes.workspace is scoped when they have an active Environment administrator assignment in the Account, account when they have only account-level authority (ownership or account capabilities other than Console ones), and none otherwise. product_landing is chooser for Console access plus scoped Workspace access, then console, then workspace, else none. Callers need only active membership of the Account, no capability.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Path Parameters

accountSlugstring Required

The Account's slug. An unknown one answers 404.

Responses

application/json

  • dataAccessLandingResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

AccessLandingResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/me/landing" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "product_landing": "console",
    "access_modes": {
      "console": "granted",
      "workspace": "scoped"
    }
  }
}
 Related endpoints
GETList the current user's own Developer Console capabilities
GETList the current user's own Account-governance capabilities
 Was this page helpful?

Tell us how we can improve this guide.

Canopy