Add a member to an organization

POST

/api/v1/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 Option A

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

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

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*

Returned object

OrganizationMemberResponseDtoView all properties on this resource

Request

curl -X POST "https://auth.canopy-io.com/api/v1/organizations/value/members" \
  -H "X-API-Key: $CANOPY_API_KEY" \
  -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
  }
}

GETWhat the caller administers in an organization
GETList the organization's tree as the caller sees it
GETList who holds a role at a node in the organization
GETSummarize who holds a role at a node in the organization
GETList the roles the caller may grant at a node
GETList the organization's members, for granting a role at a node
POSTGrant a role at a node beneath the organization
PATCHChange a grant in the organization
DELETETake a grant in the organization away
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
POSTRegenerate the organization's SSO recovery codes
POSTStart a test sign-in on the organization's connection
GETRead the organization's test sign-in
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
POSTReset a member's multi-factor authentication
GETList an organization's invitations
POSTInvite a member into an organization
GETList the roles an organization may assign
DELETERevoke an organization invitation
GETGet an organization's SSO connection
POSTSet up an organization's SSO connection
PATCHChange an organization's SSO connection
DELETERemove an organization's SSO connection
POSTActivate an organization's SSO connection
POSTDisable an organization's SSO connection
POSTImport the identity provider's SAML metadata
GETList the connection's recent sign-ins
GETList the roles the organization's SSO sign-ins may arrive with
GETGet the service-provider values for an organization's SSO connection
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
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 groups an organization's provider has pushed
PUTMap a pushed group to one of the available roles
DELETEClear a pushed group's role mapping

Was this page helpful?

Tell us how we can improve this guide.