Invitations
Invite someone into the current tenant
A live invitation for the same address is retired and replaced, so a retry or a "send it again" is this same call. ALREADY_EXISTS when the address is already a member. INVALID_ARGUMENT for a role that cannot be granted by invitation: OWNER moves by transfer, and APP_CREATOR is a capability rather than a role.
Scope: user:write
Authorization
bearerAuth AuthorizationBearer <token>
Personal Access Token (PAT) or Service Access Token (SAT). Pass the token in the Authorization header: Bearer admp_...
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
CreateInvitationRequest invites one address into the caller's tenant.
Response Body
application/json
curl -X POST "https://example.com/v1/invitations" \ -H "Content-Type: application/json" \ -d '{ "email": "user@example.com", "role": "USER_ROLE_ADMIN" }'{ "invitation": { "id": "string", "email": "string", "role": "USER_ROLE_UNSPECIFIED", "status": "INVITATION_STATUS_UNSPECIFIED", "invited_by": "string", "created_at": "2023-01-15T01:30:15.01Z", "expires_at": "2023-01-15T01:30:15.01Z", "accepted_at": "2023-01-15T01:30:15.01Z", "accepted_user_id": "string", "revoked_at": "2023-01-15T01:30:15.01Z" }}