1. Docs
  2. API Reference
  3. Resolve the caller's operational authority in the Environment

Resolve the caller's operational authority in the Environment

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/workspace/context

The caller's operational-administration authority in this Environment, which the Admin Workspace resolves on entry: has_access, environment_wide, accessible_node_ids and capabilities. No capability is required. A caller with no live assignment here gets has_access: false with an empty scope, not a 403. The account owner and holders of workspace.administer_all get Environment-wide access and every operational capability without needing an assignment. Everyone else gets the union of capabilities granted by the roles of their live assignments, and the node subtrees those assignments cover.

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.

appSlugstring Required

The Application's slug within the Account.

envSlugstring Required

The Environment's slug within the Application.

Responses

application/json

  • dataWorkspaceContextResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

WorkspaceContextResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/workspace/context" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "has_access": false,
    "environment_wide": false,
    "accessible_node_ids": [
      "string"
    ],
    "capabilities": [
      "string"
    ]
  }
}
 Related endpoints
GETList identities within the caller's operational scope
GETList an identity's responsibilities within the caller's scope
GETList the identity roles the caller may grant
GETList the hierarchy locations the caller may assign at
GETList the hierarchy nodes the caller can see in this Environment
GETList identity invitations within the caller's scope
POSTInvite an identity into a location with a role
GETList scoped operational activity within the caller's scope
GETDownload the scoped activity feed as CSV
GETHow long activity history is kept for this Account
POSTResend a scoped invitation
DELETERevoke a scoped invitation
POSTGrant an identity a role at a hierarchy node
PATCHMove or re-role an existing assignment
DELETERemove an identity's role assignment
 Was this page helpful?

Tell us how we can improve this guide.

Canopy