Create Tenant Membership

POST

/v1/memberships/tenant

Create a TenantMembership. Typically driven by WorkOS webhooks, not direct API calls.

Request Body ^required

TenantMembershipCreate

Fields required to record a new TenantMembership (synced from WorkOS).

object

user_id

required

User Id

string format: uuid

workos_membership_id

required

Workos Membership Id

string

role

Role

string

default: member

is_active

Is Active

boolean

default: true

invited_by_user_id

Any of:

string

string

null

null

joined_at

Any of:

string

string format: date-time

null

null

Responses

201

Successful Response

Response[TenantMembershipRead]

object

data

required

TenantMembershipRead

Full representation of a TenantMembership record.

object

id

required

Id

string format: uuid

tenant_id

required

Tenant Id

string format: uuid

workos_org_id

required

Workos Org Id

string

created_at

required

Created At

string format: date-time

created_by_user_id

required

Created By User Id

string

updated_at

required

Updated At

string format: date-time

updated_by_user_id

required

Updated By User Id

string

archived_at

Any of:

string

string format: date-time

null

null

archived_by_user_id

Any of:

string

string

null

null

archive_reason

Any of:

string

string

null

null

deleted_at

Any of:

string

string format: date-time

null

null

deleted_by_user_id

Any of:

string

string

null

null

delete_reason

Any of:

string

string

null

null

user_id

required

User Id

string format: uuid

workos_membership_id

required

Workos Membership Id

string

role

required

Role

string

is_active

required

Is Active

boolean

invited_by_user_id

Any of:

string

string

null

null

joined_at

Any of:

string

string format: date-time

null

null

meta

ResponseMeta

Metadata included in every response envelope.

object

request_id

Any of:

string

string

null

null

organization_id

Any of:

string

string

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object