Added identity providers —
Check the API reference
LogoLogo
Other APIsChangelog
  • Welcome to Provisioning API
  • Getting started
    • API specification
    • Authorization
    • Applications
  • API reference
    • API credentials
      • The API credential object
      • Create an API credential
      • List all API credentials
      • Retrieve an API credential
      • Update an API credential
      • Delete an API credential
    • Application memberships
      • The application membership object
      • Create an application membership
      • List all application memberships
      • Retrieve an application membership
      • Update an application membership
      • Delete an application membership
    • Identity providers
      • The identity provider object
      • Create an identity provider
      • List all identity providers
      • Retrieve an identity provider
      • Update an identity provider
      • Delete an identity provider
    • Memberships
      • The membership object
      • Create a membership
      • List all memberships
      • Retrieve a membership
      • Update a membership
      • Delete a membership
    • Membership profiles
      • The membership profile object
      • Create a membership profile
      • List all membership profiles
      • Retrieve a membership profile
      • Update a membership profile
      • Delete a membership profile
    • Organizations
      • The organization object
      • Create an organization
      • List all organizations
      • Retrieve an organization
      • Update an organization
    • Permissions
      • The permission object
      • Create a permission
      • List all permissions
      • Retrieve a permission
      • Update a permission
    • Roles
      • The role object
      • Create a role
      • List all roles
      • Retrieve a role
      • Update a role
    • User
      • The user object
      • Retrieve the user
      • Update the user
    • Versions
      • The version object
      • List all versions
      • Retrieve a version
On this page
  • Granting access to the test environment
  • Resending an invitation
  • Example
  1. API reference

Memberships

The membership object and the allowed CRUD operations on the related resource endpoint

PreviousDelete an identity providerNextThe membership object

Last updated 6 days ago

At the moment of , when you create your first , a membership with an admin role is automatically generated for the account owner. Admins can then invite one or more users to join the organization by associated with the user's email address.

New members can also be assigned a , a , and one or more application memberships by associating each of them with the membership. The new member(s) will receive the invitation by email and will be prompted to create an account if they don’t already have one or to sign in to the Dashboard if they do. Memberships are created in a pending status, which becomes active as soon as the member accepts the invitation. If that doesn't happen, the invitation can be resent by calling . If the invited users already exist (i.e. they already have an account), the related memberships will be directly created as active.

Members that haven't an admin role cannot create membership and are allowed to delete only their own. Admins can delete other users' memberships. Membership creation can also be limited due to your .

Some basic member information (e.g. the user's email, first and last name) is directly available when the related membership. The members who are owners of the associated organization will have the owner flag set to true.

The owner attribute is read-only. To transfer the ownership to another member of the organization you need to . Owners cannot delete their own membership without transferring it first.

Granting access to the test environment

You can allow selected members to try some Dashboard apps with test data by setting the test_enabled attribute to true at the membership level. This way members will be able to work in the test environment for the Dashboard applications to which they have been granted access in test mode via application membership (a live/test toggle will be shown on the Dashboard).

The test_enabled attribute can also be set at the level. In case of conflicts, the settings of the membership profile have precedence over the ones of the single memberships.

At the moment this feature isn't available for or .

Resending an invitation

To resend an invitation to the user email associated with a (still) pending membership, send a POST request to the /api/memberships/:id/resend endpoint, where :id is the ID of the membership in question, with an empty body payload.

Example

The following request resends an invitation for the membership identified by the "xYZkjABcde" ID:

curl -g -X POST \
  'https://provisioning.commercelayer.io/api/memberships/xYZkjABcde/resend' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer {{your_access_token}}' \
  -H 'Content-Type: application/vnd.api+json' \
  -d ''

On success, the API responds with a 202 Accepted status code.

signup
organization
creating a new membership
role
membership profile
fetching
a dedicated endpoint
custom apps
webapps
membership profile
subscription plan type
call a dedicated endpoint