Add a member to an organization

POST

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

Adds a member. Membership is admission, not authority: with role_id the member also holds that role from the start, at the organization node or at the office or team node_id names, for the effective_from to effective_to window when given; without it they belong and hold nothing until a role is assigned (a place or dates need a role, 400 invite.window_requires_role). The identity must already hold an active membership in this Environment (invite by email instead for someone who does not). An identity that is already a member returns 409; roles are added through the assignment routes. Requires the rbac.manage_assignments permission at the organization and emits organization.member.added. An organization's own administrator, signed in with an identity token and admitted by canopy:organization.manage alone, is refused with 403 (organization.member_add_requires_invite): the person never agreed to join, so the administrator invites them instead.

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

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.

idstring Required

Request body

application/json

identity_idstring Required

Identity to add. Must already hold an active membership in this Environment; invite by email instead for someone who does not.

role_idstring Optional

A role to hold at the organization node from the start, from the Environment's roles. Left out, the member belongs and holds nothing until a role is assigned.

node_idstring Optional

Where the role is held: the organization node (the default) or an office or team beneath it. Needs a role.

effective_fromstring · date-time Optional

When the role starts to count (ISO 8601). Needs a role.

effective_tostring · date-time Optional

When the role stops counting (ISO 8601), after `effective_from`. Needs a role.

Responses

application/json

dataOrganizationMemberResponseDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

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, and a correlation_id (also sent as the X-Correlation-Id header). Quote the correlation id when you contact support: it identifies the exact request in Canopy's logs.

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 POST "https://auth.canopy-io.com/portal/v1/accounts/value/applications/value/environments/value/organizations/value/members" \
  -H "Authorization: Bearer $CANOPY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "identity_id": "string",
    "role_id": "string",
    "node_id": "string",
    "effective_from": "2026-04-20T12:00:00.000Z",
    "effective_to": "2026-04-20T12:00:00.000Z"
  }'

Response

{
  "data": {
    "id": "string",
    "identity": {
      "id": "string",
      "email": "string",
      "first_name": "string",
      "last_name": "string"
    },
    "status": "active",
    "source": "added",
    "joined_at": "2026-04-20T12:00:00.000Z",
    "deactivated_at": "2026-04-20T12:00:00.000Z",
    "roles": [
      {
        "id": "string",
        "role": {
          "id": "string",
          "name": "string"
        },
        "node": {
          "id": "string",
          "name": "string",
          "node_type": "string"
        },
        "effective_from": "2026-04-20T12:00:00.000Z",
        "effective_to": "2026-04-20T12:00:00.000Z",
        "version": 0
      }
    ],
    "version": 0
  }
}

GETList organizations
POSTCreate an organization
DELETEDelete every organization
GETGet the Environment's organization totals
GETGet an organization
PATCHUpdate an organization
DELETEDelete an organization
GETGet an organization's authentication policy
PATCHUpdate an organization's authentication policy
POSTRegenerate the organization's SSO recovery codes
POSTStart a test sign-in on the organization's connection
GETRead the organization's test sign-in
GETGet an organization's directory connection
POSTCreate an organization's directory connection
DELETERemove an organization's directory connection
GETList an organization's directory-sync tokens
POSTMint a directory-sync token for an organization
POSTReplace a directory-sync token without an outage
DELETERevoke a directory-sync token
GETList the groups an organization's provider has pushed
PUTMap a pushed group to one of the available roles
DELETEClear a pushed group's role mapping
GETRecent directory-sync activity for an organization
GETList the roles an organization's directory may grant
PUTReplace the roles an organization's directory may grant
GETList the organization's domain claims
POSTClaim a domain for the organization
POSTVerify one of the organization's domains
DELETERemove one of the organization's domain claims
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
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.