PUT /memberships/{organizationId}/{userId}

Creates or updates (upserts) a membership with a specified organization ID and user ID. Only the organization owner can grant organization membership to new users.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
_links[] Array No

Related links.

_links[].href String No

Link URL.

_links[].rel String No

Type of link.

Valid values:

  • "self"
isOwner Boolean No

Specifies if the user is the owner of the organization.

_embedded Object No

Embedded objects that are requested by the expand query parameter.

_embedded.roles[] Array No
user Object Yes

Membership user.

user.id String No

ID of the user.

user.name String No

First and last name of the user.

user.email String No

Email address of the user.

roleIds[] Array No

Role IDs associated with the user. Role IDs specify the roles that the user performs within the organization. For example, the user may be an organization admin.

isDefault Boolean No

Specifies if the organization is the default organization for the user.

allowedIps[] Array No

List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.

permissions[] Array No

Permissions that the user has within the organization. Use the wildcard character * for full access.

organization Object Yes

Organization membership.

organization.id String No

ID of the organization.

organization.name String No

Name of the organization.

organization.updatedTime String No

Date and time when the resource is updated. This value is set automatically when the resource is updated.

organization.createdTime String No

Date and time when the resource is created. This value is set automatically when the resource is created.

acl Object No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.