Members
List organization members, and add, update and remove tenant members.
list_org_members
List the people in an organization and their org role. Maps to
GET /organizations/:org/members.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
Returns the list of organization members.
list_tenant_members
List the people in a tenant with their tenant role and sign-in providers. Maps
to GET /organizations/:org/tenants/:tenant_id/members.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
tenant_id | string | Yes | The tenant |
Returns the list of tenant members.
add_tenant_member
Add a person to a tenant by email, inviting them if they have no account yet.
Maps to POST /organizations/:org/tenants/:tenant_id/members.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
tenant_id | string | Yes | The tenant |
email | string (email) | Yes | e.g. jane@acme.com |
role | owner, admin or member | No | Tenant role. Defaults to member |
first_name | string | No | |
last_name | string | No | |
picture | string (URL) | No | |
phone | string | No | |
birthday | string | No | YYYY-MM-DD |
pronouns | feminine, masculine or neutral | No | |
locales | array of string | No | |
timezone | string | No | |
postal_address | object | No | Any of street_number, street, city, postcode, region, country (all strings) |
Returns the added member.
update_tenant_member
Change a member’s tenant role or profile fields. The fields you pass are the
fields that change. Maps to
PATCH /organizations/:org/tenants/:tenant_id/members/:user_id.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
tenant_id | string | Yes | The tenant |
user_id | string | Yes | The member to update |
role | owner, admin or member | No | Tenant role |
first_name | string | No | |
last_name | string | No | |
picture | string (URL) | No | |
phone | string | No | |
birthday | string | No | YYYY-MM-DD |
pronouns | feminine, masculine or neutral | No | |
locales | array of string | No | |
timezone | string | No | |
postal_address | object | No | Any of street_number, street, city, postcode, region, country (all strings) |
Returns the updated member.
remove_tenant_member
Remove a person from a tenant. Maps to
DELETE /organizations/:org/tenants/:tenant_id/members/:user_id.
| Name | Type | Required | Description |
|---|---|---|---|
org | string | Yes | Organization id (org_…) or slug |
tenant_id | string | Yes | The tenant |
user_id | string | Yes | The member to remove |
Returns OK (no content).