NEnexla
Organizations

Update Organization Members

Add or update members in an organization. This endpoint can also be used to modify an existing member's role in the organization.

When adding a new member using their email id, if a user account for that email id does not exist on the platform then a new user account will be created. If the user already exists on the platform as a member of a different organization then their membership will get updated to include this organization also.

put/orgs/{org_id}/members

Request

Path parameters

org_idinteger required

The unique ID of the organization.

Request body

Response

Success

idinteger

Nexla User ID of this user.

full_namestring
emailstring
is_admin?boolean

Indicates whether this user is an administrator for the organization or not.

access_rolestring[]

This property reflects all the permissions the user/team/organization has to this resource.

  1. collaborator: The user/team/organization can view the resource but not make any modifications to it.
  2. operator: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it.
  3. administrator: The user/team/organization has complete administrative rights to this resource.
  4. owner: This user created the resource and so has complete administrative rights to it.
org_membership_status'ACTIVE' | 'DEACTIVATED'

Indicates whether the user's membership in this organization is active or not.

If the membership is DEACTIVATED the user can no longer access the account but the resources owned by them will still be accessible by the organization administrators.

user_status'ACTIVE' | 'DEACTIVATED' | 'SOURCE_COUNT_CAPPED' | 'SOURCE_DATA_CAPPED' | 'TRIAL_EXPIRED'

Indicates the user's account status across all organizations they are members of.

Changes

No recorded changes to this operation across all 1 revision of this API.