Skip to main content
POST
Python SDK

Access

This operation needs a Parable token. An MCP token cannot call it. See Authentication for the kinds of token. Your roles must grant tenant.user.create.

Errors

  • HTTP 422: The invitation input is invalid, such as missing roles or an ineligible person. Provide a valid person and at least one assignable role.
  • HTTP 403: You cannot invite people or assign the requested roles in this Workspace. Choose roles within your authority or ask a Workspace administrator.
  • WA-TN-003: Parable manages who is a member of this Workspace, so nobody can be invited or reactivated in it. Ask your Parable representative to give the person access.

Authorizations

Authorization
string
header
required

A personal access token, which starts with pat_. A Parable token can call each operation that the roles of its owner allow. An MCP token can call only the read operations that are open to agents. A SQL token does not work on this API.

Headers

X-Tenant
string

Workspace slug. Overrides subdomain-based workspace resolution when provided.

Example:

"acme"

X-Request-ID
string<uuid>

Optional request correlation ID echoed back in the response.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json
email
string<email>
required

An email address

Maximum string length: 255
Pattern: ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$
roleIds
string[]
required

Role IDs to assign to the user upon invite. At least one role is required.

UUID v4 with automatic base62 encoding for client-facing APIs

Pattern: ^([0-9A-Za-z]{1,22}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

Successful response

data
object
required

The base info about a user. id stays Identity.UserID (not Auditable's Identity.UUID) so the wire/auth contract keeps the actor scalar.

meta
object
required