1. Docs
  2. API Reference
  3. Change a member's role

Change a member's role

PATCH/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/organizations/{id}/members/{identityId}

Replaces the member's role in this organization with role_id. A member holds exactly one role per organization, so this updates the existing membership in place; changing to the role already held is a no-op. Returns 404 when the identity is not a member. Requires the rbac.manage_assignments permission at the organization and emits organization.member.role_changed.

Authentication

Bearer TokenAuthorization

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

Requires capability env_identities.manageDeveloper Console

Create, invite, edit, and remove identities and assign their roles. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Production Environments require production_identities.accessDeveloper Console

Access identities in production Environments. Applies to users only, and only in an Environment marked production: its identities are real end users. API keys and identity principals are exempt.

Path Parameters

idstring Required
identityIdstring Required

Request body

application/json

role_idstring Required

The replacement role. A member holds exactly one role per organization, so this updates the existing membership in place.

Responses

application/json

  • dataOrganizationMemberResponseDto*

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.

403environment.production_identities_forbiddenForbidden
When it happens

The Environment is marked production and the caller is a user without production identity access.

Remediation

Manage these people in the Admin Workspace, or ask an administrator to grant the Production Support role, then retry.

Returned object

OrganizationMemberResponseDtoView all properties on this resource
Request
curl -X PATCH "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/organizations/value/members/value" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "role_id": "string"
  }'
Response
{
  "data": {
    "id": "string",
    "identity": {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string"
    },
    "role": {
      "id": "string",
      "name": "string"
    },
    "effective_from": "2026-04-20T12:00:00.000Z",
    "effective_to": "2026-04-20T12:00:00.000Z",
    "created_at": "2026-04-20T12:00:00.000Z",
    "node_assignments": [
      {
        "id": "string",
        "application_node": {
          "id": "string",
          "name": "string",
          "node_type": "string"
        },
        "role": {
          "id": "string",
          "name": "string"
        }
      }
    ]
  }
}
 Related endpoints
GETList organizations
POSTCreate an organization
DELETEDelete every organization
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
GETGet an organization's authentication policy
PATCHUpdate an organization's authentication policy
GETList an organization's SSO connections
POSTBind an SSO connection to an organization
DELETEUnbind an SSO connection from an organization
GETList an organization's members
POSTAdd a member to an organization
DELETERemove a member from an organization
GETList an organization's invitations
POSTInvite a member into an organization
DELETERevoke an organization invitation
 Was this page helpful?

Tell us how we can improve this guide.

Canopy