Tenant Members

Tenant Members enable user management operations within the context of a Tenant. New members can be invited via e-mail to join an existing tenant. Upon accepting a Tenant Invitation, a new Tenant Member will be created.

List Tenant Members

Get a list of Tenant Members for the Tenant.

GET https://api.basistheory.com/tenants/self/members

Permissions

tenant:member:read

Request

cURL
JavaScript
C#
Python
Go

curl "https://api.basistheory.com/tenants/self/members" \
  -H "BT-API-KEY: key_N88mVGsp3sCXkykyN2EFED"

import { BasisTheory } from "@basis-theory/basis-theory-js";

const bt = await new BasisTheory().init("key_N88mVGsp3sCXkykyN2EFED");

const tenantMembers = await bt.tenants.listMembers();

using BasisTheory.net.Tenants;

var client = new TenantClient("key_N88mVGsp3sCXkykyN2EFED");

var tenantMembers = await client.GetMembersAsync();

import basistheory
from basistheory.api import tenants_api

with basistheory.ApiClient(configuration=basistheory.Configuration(api_key="key_N88mVGsp3sCXkykyN2EFED")) as api_client:
    tenant_client = tenants_api.TenantsApi(api_client)

    tenant_members = tenant_client.get_members()

package main

import (
  "context"
  "github.com/Basis-Theory/basistheory-go/v3"
)

func main() {
  configuration := basistheory.NewConfiguration()
  apiClient := basistheory.NewAPIClient(configuration)
  contextWithAPIKey := context.WithValue(context.Background(), basistheory.ContextAPIKeys, map[string]basistheory.APIKey{
    "ApiKey": {Key: "key_N88mVGsp3sCXkykyN2EFED"},
  })

  tenantMembers, httpResponse, err := apiClient.TenantsApi.GetMembers(contextWithAPIKey).Execute()
}

Query Parameters

Parameter	Required	Type	Default	Description
`user_id`	false	uuid	`null`	One to many User IDs to query for. Multiple IDs can be passed in the form `?user_id=<value1>&user_id=<value2>`.
`page`	false	integer	`1`	Page number of the results to return.
`size`	false	integer	`20`	Number of the results to return per page. Maximum size of 50 results.

Response

Returns a paginated object with the data property containing an array of Tenant Members. Providing any query parameters will filter the results. Returns an error if Tenant Members could not be retrieved.

{
  "pagination": {...},
  "data": [
    {
      "id": "5540a02f-99e7-46de-8f41-1b3cf7b2a3d2",
      "tenant_id": "77cb0024-123e-41a8-8ff8-a3d5a0fa8a08",
      "role": "ADMIN",
      "user": {
        "id": "dc5fca8c-dd54-41df-98fc-50d7a1e7fb4d",
        "email": "jane@doe.com",
        "first_name": "Jane",
        "last_name": "Doe",
        "picture": ""
      },
      "created_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",
      "created_at": "2020-09-15T15:53:00+00:00",
      "modified_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",
      "modified_at": "2021-03-01T08:23:14+00:00"
    },
    {...},
    {...}
  ]
}

Delete Tenant Member

Delete a Tenant Member by ID from the Tenant. Deleting a Tenant Member will revoke all access from the Tenant.

DELETE https://api.basistheory.com/tenants/self/members/{id}

Permissions

tenant:member:delete

Request

cURL
JavaScript
C#
Python
Go

curl "https://api.basistheory.com/tenants/self/members/5540a02f-99e7-46de-8f41-1b3cf7b2a3d2" \
  -H "BT-API-KEY: key_N88mVGsp3sCXkykyN2EFED" \
  -X "DELETE"

import { BasisTheory } from "@basis-theory/basis-theory-js";

const bt = await new BasisTheory().init("key_N88mVGsp3sCXkykyN2EFED");

await bt.tenants.deleteMember("5540a02f-99e7-46de-8f41-1b3cf7b2a3d2");

using BasisTheory.net.Tenants;

var client = new TenantClient("key_N88mVGsp3sCXkykyN2EFED");

await client.DeleteMemberAsync("5540a02f-99e7-46de-8f41-1b3cf7b2a3d2");

import basistheory
from basistheory.api import tenants_api

with basistheory.ApiClient(configuration=basistheory.Configuration(api_key="key_N88mVGsp3sCXkykyN2EFED")) as api_client:
    tenant_client = tenants_api.TenantsApi(api_client)

    tenant_client.delete_member(member_id="5540a02f-99e7-46de-8f41-1b3cf7b2a3d2")

package main

import (
  "context"
  "github.com/Basis-Theory/basistheory-go/v3"
)

func main() {
  configuration := basistheory.NewConfiguration()
  apiClient := basistheory.NewAPIClient(configuration)
  contextWithAPIKey := context.WithValue(context.Background(), basistheory.ContextAPIKeys, map[string]basistheory.APIKey{
    "ApiKey": {Key: "key_N88mVGsp3sCXkykyN2EFED"},
  })

  httpResponse, err := apiClient.TenantsApi.DeleteMember(contextWithAPIKey, "5540a02f-99e7-46de-8f41-1b3cf7b2a3d2").Execute()
}

URI Parameters

Parameter	Required	Type	Default	Description
`id`	true	uuid	`null`	The ID of the Tenant Member

Response

Returns an error if the Tenant Member could not be deleted.

Create Tenant Invitation

Invite a new member to join this Tenant. Creating a Tenant Invitation will send an e-mail to the recipient containing a link to accept the invitation.

POST https://api.basistheory.com/tenants/self/invitations

Permissions

tenant:invitation:create

Request

cURL
JavaScript
C#
Python
Go

curl "https://api.basistheory.com/tenants/self/invitations" \
  -H "BT-API-KEY: key_N88mVGsp3sCXkykyN2EFED" \
  -H "Content-Type: application/json" \
  -X "POST" \
  -d '{
    "email": "jane@doe.com",
  }'

import { BasisTheory } from "@basis-theory/basis-theory-js";

const bt = await new BasisTheory().init("key_N88mVGsp3sCXkykyN2EFED");

const createdInvitation = await bt.tenants.createInvitations({
  email: "jane@doe.com",
});

using BasisTheory.net.Tenants;

var client = new TenantClient("key_N88mVGsp3sCXkykyN2EFED");

var createdInvitation = await client.CreateInvitationAsync(new TenantInvitation
{
    Email = "jane@doe.com"
});

import basistheory
from basistheory.api import tenants_api
from basistheory.model.create_tenant_invitation_request import CreateTenantInvitationRequest

with basistheory.ApiClient(configuration=basistheory.Configuration(api_key="key_N88mVGsp3sCXkykyN2EFED")) as api_client:
    tenant_client = tenants_api.TenantsApi(api_client)

    created_invitation = tenant_client.create_invitation(create_tenant_invitation_request=CreateTenantInvitationRequest(
        email="jane@doe.com"
    ))

package main

import (
  "context"
  "github.com/Basis-Theory/basistheory-go/v3"
)

func main() {
  configuration := basistheory.NewConfiguration()
  apiClient := basistheory.NewAPIClient(configuration)
  contextWithAPIKey := context.WithValue(context.Background(), basistheory.ContextAPIKeys, map[string]basistheory.APIKey{
    "ApiKey": {Key: "key_N88mVGsp3sCXkykyN2EFED"},
  })

  createTenantInvitationRequest := *basistheory.NewCreateTenantInvitationRequest("jane@doe.com")

  createdInvitation, httpResponse, err := apiClient.TenantsApi.CreateInvitation(contextWithAPIKey).CreateTenantInvitationRequest(createTenantInvitationRequest).Execute()
}

Request Parameters

Attribute	Required	Type	Default	Description
`email`	true	string	`null`	The invitee's e-mail address. Has to be a well-formed e-mail address (RFC 5322).

Response

Returns a Tenant Invitation if the Tenant Invitation was created. Returns an error if there were validation errors, or the Tenant Invitation failed to create.

{
  "id": "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13",
  "tenant_id": "77cb0024-123e-41a8-8ff8-a3d5a0fa8a08",
  "email": "jane@doe.com",
  "status": "PENDING",
  "expires_at": "2020-09-18T15:53:00+00:00",
  "created_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",
  "created_at": "2020-09-15T15:53:00+00:00"
}

Resend Tenant Invitation

Resend a pending or expired Tenant Invitation. Resending the invitation will extend the expiration by 72 hours and invalidate any previous invitation link(s) sent to the recipient.

POST https://api.basistheory.com/tenants/self/invitations/{id}/resend

Permissions

tenant:invitation:createtenant:invitation:update

Request

cURL
JavaScript
C#
Python
Go

curl "https://api.basistheory.com/tenants/self/invitations/fb32ea26-2185-4ad2-a7bf-2fe69c00ae13/resend" \
  -H "BT-API-KEY: key_N88mVGsp3sCXkykyN2EFED" \
  -H "Content-Type: application/json" \
  -X "POST"

import { BasisTheory } from "@basis-theory/basis-theory-js";

const bt = await new BasisTheory().init("key_N88mVGsp3sCXkykyN2EFED");

const resentInvitation = await bt.tenants.resendInvitation(
  "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13"
);

using BasisTheory.net.Tenants;

var client = new TenantClient("key_N88mVGsp3sCXkykyN2EFED");

var resentInvitation = await client.ResendInvitationAsync("fb32ea26-2185-4ad2-a7bf-2fe69c00ae13");

import basistheory
from basistheory.api import tenants_api

with basistheory.ApiClient(configuration=basistheory.Configuration(api_key="key_N88mVGsp3sCXkykyN2EFED")) as api_client:
    tenant_client = tenants_api.TenantsApi(api_client)

    resent_invitation = tenant_client.resend_invitation(invitation_id="dfd0319e-e978-4d2a-9109-f8a9048088bd")

package main

import (
  "context"
  "github.com/Basis-Theory/basistheory-go/v3"
)

func main() {
  configuration := basistheory.NewConfiguration()
  apiClient := basistheory.NewAPIClient(configuration)
  contextWithAPIKey := context.WithValue(context.Background(), basistheory.ContextAPIKeys, map[string]basistheory.APIKey{
    "ApiKey": {Key: "key_N88mVGsp3sCXkykyN2EFED"},
  })

  resentInvitation, httpResponse, err := apiClient.TenantsApi.ResendInvitation(contextWithAPIKey, "dfd0319e-e978-4d2a-9109-f8a9048088bd").Execute()
}

URI Parameters

Parameter	Required	Type	Default	Description
`id`	true	uuid	`null`	The ID of the Tenant Invitation

Response

Returns a Tenant Invitation if the Tenant Invitation was resent. Returns an error if there were validation errors, or the Tenant Invitation failed to resend.

{
  "id": "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13",
  "tenant_id": "77cb0024-123e-41a8-8ff8-a3d5a0fa8a08",
  "email": "jane@doe.com",
  "status": "PENDING",
  "expires_at": "2020-09-18T15:53:00+00:00",
  "created_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",
  "created_at": "2020-09-15T15:53:00+00:00"
}

List Tenant Invitations

Get a list of Tenant Invitations for the Tenant.

GET https://api.basistheory.com/tenants/self/invitations

Permissions

tenant:invitation:read

Request

cURL
JavaScript
C#
Python
Go

curl "https://api.basistheory.com/tenants/self/invitations" \
  -H "BT-API-KEY: key_N88mVGsp3sCXkykyN2EFED"

import { BasisTheory } from "@basis-theory/basis-theory-js";

const bt = await new BasisTheory().init("key_N88mVGsp3sCXkykyN2EFED");

const invitations = await bt.tenants.listInvitations();

using BasisTheory.net.Tenants;

var client = new TenantClient("key_N88mVGsp3sCXkykyN2EFED");

var invitations = await client.GetInvitationsAsync();

import basistheory
from basistheory.api import tenants_api

with basistheory.ApiClient(configuration=basistheory.Configuration(api_key="key_N88mVGsp3sCXkykyN2EFED")) as api_client:
    tenant_client = tenants_api.TenantsApi(api_client)

    invitations = tenant_client.get_invitations()

package main

import (
  "context"
  "github.com/Basis-Theory/basistheory-go/v3"
)

func main() {
  configuration := basistheory.NewConfiguration()
  apiClient := basistheory.NewAPIClient(configuration)
  contextWithAPIKey := context.WithValue(context.Background(), basistheory.ContextAPIKeys, map[string]basistheory.APIKey{
    "ApiKey": {Key: "key_N88mVGsp3sCXkykyN2EFED"},
  })

  invitations, httpResponse, err := apiClient.TenantsApi.GetInvitations(contextWithAPIKey).Execute()
}

Query Parameters

Parameter	Required	Type	Default	Description
`page`	false	integer	`1`	Page number of the results to return.
`size`	false	integer	`20`	Number of the results to return per page. Maximum size of 100 results.

Response

Returns a paginated object with the data property containing an array of Tenant Invitations. Providing any query parameters will filter the results. Returns an error if Tenant Invitations could not be retrieved.

{
  "pagination": {...},
  "data": [
    {
      "id": "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13",
      "tenant_id": "77cb0024-123e-41a8-8ff8-a3d5a0fa8a08",
      "email": "jane@doe.com",
      "status": "PENDING",
      "expires_at": "2020-09-18T15:53:00+00:00",
      "created_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",
      "created_at": "2020-09-15T15:53:00+00:00"
    },
    {...},
    {...}
  ]
}

Get a Tenant Invitation

Get a Tenant Invitation by ID in the Tenant.

GET https://api.basistheory.com/tenants/self/invitations/{id}

Permissions

tenant:invitation:read

Request

cURL
JavaScript
C#
Python
Go

curl "https://api.basistheory.com/tenants/self/invitations/fb32ea26-2185-4ad2-a7bf-2fe69c00ae13" \
  -H "BT-API-KEY: key_N88mVGsp3sCXkykyN2EFED"

import { BasisTheory } from "@basis-theory/basis-theory-js";

const bt = await new BasisTheory().init("key_N88mVGsp3sCXkykyN2EFED");

const invitation = await bt.tenants.retrieveInvitation(
  "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13"
);

using BasisTheory.net.Tenants;

var client = new TenantClient("key_N88mVGsp3sCXkykyN2EFED");

var invitation = await client.GetInvitationByIdAsync("fb32ea26-2185-4ad2-a7bf-2fe69c00ae13");

import basistheory
from basistheory.api import tenants_api

with basistheory.ApiClient(configuration=basistheory.Configuration(api_key="key_N88mVGsp3sCXkykyN2EFED")) as api_client:
    tenant_client = tenants_api.TenantsApi(api_client)

    invitation = tenant_client.get_invitation_by_id(invitation_id="fb32ea26-2185-4ad2-a7bf-2fe69c00ae13")

package main

import (
  "context"
  "github.com/Basis-Theory/basistheory-go/v3"
)

func main() {
  configuration := basistheory.NewConfiguration()
  apiClient := basistheory.NewAPIClient(configuration)
  contextWithAPIKey := context.WithValue(context.Background(), basistheory.ContextAPIKeys, map[string]basistheory.APIKey{
    "ApiKey": {Key: "key_N88mVGsp3sCXkykyN2EFED"},
  })

  invitation, httpResponse, err := apiClient.TenantsApi.GetInvitationById(contextWithAPIKey, "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13").Execute()
}

URI Parameters

Parameter	Required	Type	Default	Description
`id`	true	uuid	`null`	The ID of the Tenant Invitation

Response

Returns a Tenant Invitation with the id provided. Returns an error if the Tenant Invitation could not be retrieved.

{
  "id": "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13",
  "tenant_id": "77cb0024-123e-41a8-8ff8-a3d5a0fa8a08",
  "email": "jane@doe.com",
  "status": "PENDING",
  "expires_at": "2020-09-18T15:53:00+00:00",
  "created_by": "fb124bba-f90d-45f0-9a59-5edca27b3b4a",
  "created_at": "2020-09-15T15:53:00+00:00"
}

Delete Tenant Invitation

Delete a Tenant Invitation by ID from the Tenant. Deleting a Tenant Invitation will invalidate any outstanding invitation links sent to the recipient.

DELETE https://api.basistheory.com/tenants/self/invitations/{id}

Permissions

tenant:invitation:delete

Request

cURL
JavaScript
C#
Python
Go

curl "https://api.basistheory.com/tenants/self/invitations/fb32ea26-2185-4ad2-a7bf-2fe69c00ae13" \
  -H "BT-API-KEY: key_N88mVGsp3sCXkykyN2EFED" \
  -X "DELETE"

import { BasisTheory } from "@basis-theory/basis-theory-js";

const bt = await new BasisTheory().init("key_N88mVGsp3sCXkykyN2EFED");

await bt.tenants.deleteInvitation("fb32ea26-2185-4ad2-a7bf-2fe69c00ae13");

using BasisTheory.net.Tenants;

var client = new TenantClient("key_N88mVGsp3sCXkykyN2EFED");

await client.DeleteInvitationAsync("fb32ea26-2185-4ad2-a7bf-2fe69c00ae13");

import basistheory
from basistheory.api import tenants_api

with basistheory.ApiClient(configuration=basistheory.Configuration(api_key="key_N88mVGsp3sCXkykyN2EFED")) as api_client:
    tenant_client = tenants_api.TenantsApi(api_client)

    tenant_client.delete_invitation(invitation_id="fb32ea26-2185-4ad2-a7bf-2fe69c00ae13")

package main

import (
  "context"
  "github.com/Basis-Theory/basistheory-go/v3"
)

func main() {
  configuration := basistheory.NewConfiguration()
  apiClient := basistheory.NewAPIClient(configuration)
  contextWithAPIKey := context.WithValue(context.Background(), basistheory.ContextAPIKeys, map[string]basistheory.APIKey{
    "ApiKey": {Key: "key_N88mVGsp3sCXkykyN2EFED"},
  })

  httpResponse, err := apiClient.TenantsApi.DeleteInvitation(contextWithAPIKey, "fb32ea26-2185-4ad2-a7bf-2fe69c00ae13").Execute()
}

URI Parameters

Parameter	Required	Type	Default	Description
`id`	true	uuid	`null`	The ID of the Tenant Invitation

Response

Returns an error if the Tenant Invitation could not be deleted.

Tenant Member Object

Attribute	Type	Description
`id`	uuid	Unique identifier of the Tenant Member
`tenant_id`	uuid	The Tenant ID that the membership is attached
`role`	string	The Role assigned to the Tenant Member
`user`	user object	The User which this membership is attached to
`created_by`	uuid	(Optional) The ID of the User or Application that created the Tenant Member
`created_at`	date	(Optional) Created date of the Tenant Member in ISO 8601 format
`modified_by`	uuid	(Optional) The ID of the User or Application that last modified the Tenant Member
`modified_at`	date	(Optional) Last modified date of the Tenant Member in ISO 8601 format

Roles

Role	Description
`OWNER`	The `OWNER` role is automatically assigned to the Tenant Owner and grants full access to all features. The Tenant `OWNER` cannot be deleted.
`ADMIN`	The `ADMIN` role is assigned by default to all members and grants full access to all features.

User Object

Attribute	Type	Description
`id`	uuid	Unique identifier of the User
`email`	string	(Optional) The e-mail address of the User
`first_name`	string	(Optional) The User's first name
`last_name`	string	(Optional) The User's last name
`picture`	string	(Optional) A URI pointing to the User's picture

Tenant Invitation Object

Attribute	Type	Description
`id`	uuid	Unique identifier of the Tenant Invitation
`tenant_id`	uuid	The Tenant ID that the invitation is tied to. When the invitation is accepted, a new Tenant Member will be created in this Tenant.
`email`	string	The invitee's e-mail address
`status`	string	The status of the invitation (i.e. `PENDING` or `EXPIRED`)
`expires_at`	date	The expiration date of the invitation is ISO 8601 format. By default, the invitation expires 72 hours from the time it was created. Invitations can be resent to extend the expiration, but doing so will invalidate the previous invitation link sent to the invitee.
`created_by`	uuid	(Optional) The ID of the User or Application that created the Tenant Invitation
`created_at`	date	(Optional) Created date of the Tenant Invitation in ISO 8601 format
`modified_by`	uuid	(Optional) The ID of the User or Application that last modified the Tenant Invitation
`modified_at`	date	(Optional) Last modified date of the Tenant Invitation in ISO 8601 format

Tenant Members

List Tenant Members​

Permissions​

Request​

Query Parameters​

Response​

Delete Tenant Member​

Permissions​

Request​

URI Parameters​

Response​

Create Tenant Invitation​

Permissions​

Request​

Request Parameters​

Response​

Resend Tenant Invitation​

Permissions​

Request​

URI Parameters​

Response​

List Tenant Invitations​

Permissions​

Request​

Query Parameters​

Response​

Get a Tenant Invitation​

Permissions​

Request​

URI Parameters​

Response​

Delete Tenant Invitation​

Permissions​

Request​

URI Parameters​

Response​

Tenant Member Object​

Roles​

User Object​

Tenant Invitation Object​

List Tenant Members

Permissions

Request

Query Parameters

Response

Delete Tenant Member

Permissions

Request

URI Parameters

Response

Create Tenant Invitation

Permissions

Request

Request Parameters

Response

Resend Tenant Invitation

Permissions

Request

URI Parameters

Response

List Tenant Invitations

Permissions

Request

Query Parameters

Response

Get a Tenant Invitation

Permissions

Request

URI Parameters

Response

Delete Tenant Invitation

Permissions

Request

URI Parameters

Response

Tenant Member Object

Roles

User Object

Tenant Invitation Object