1. Docs
  2. API Reference
  3. Get an Account identity

Get an Account identity

GET/portal/v1/accounts/{accountSlug}/identities/{id}

Returns the full detail record for one identity by id, scoped to this Account. Includes profile, status, and EnvironmentMembership / assignment context across the Account's Environments. Returns 404 for an unknown id or one owned by another Account (indistinguishable on the wire).

Authentication

Bearer TokenAuthorization

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

Requires capability identities.viewIdentities

View end-user identities across the account. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

idstring Required

Responses

application/json

  • dataAccountIdentityDetailResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

AccountIdentityDetailResponseDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/identities/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "id": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "avatar_url": "string",
    "external_id": "string",
    "metadata": {},
    "is_active": false,
    "erased_at": "2026-04-20T12:00:00.000Z",
    "email_verified": false,
    "email_verified_at": "2026-04-20T12:00:00.000Z",
    "locked_until": "2026-04-20T12:00:00.000Z",
    "password_changed_at": "2026-04-20T12:00:00.000Z",
    "environment_membership_count": 0,
    "total_assignments": 0,
    "created_at": "2026-04-20T12:00:00.000Z",
    "environment_memberships": [
      {
        "id": "string",
        "environment_id": "string",
        "environment_slug": "string",
        "environment_name": "string",
        "application_slug": "string",
        "application_name": "string",
        "status": "active",
        "created_at": "2026-04-20T12:00:00.000Z",
        "assignment_count": 0
      }
    ]
  }
}
 Related endpoints
GETList identities in Account
POSTCreate an Account identity
POSTBulk-create Account identities
GETGet directory counts for the Account
PATCHUpdate an Account identity profile
PATCHSet Account-wide is_active flag
POSTErase an identity (GDPR/CCPA right to be forgotten)
POSTAdmin-trigger a password reset email
POSTRe-send email verification
POSTRevoke all active sessions for an identity
GETList audit events for an Account identity
POSTAdd an identity to an Environment (create EnvironmentMembership)
POSTBulk-attach EnvironmentMemberships for the Add-from-directory picker
DELETERemove an identity from an Environment (revoke EnvironmentMembership)
 Was this page helpful?

Tell us how we can improve this guide.

Canopy