OpenPermit Docs
ReferenceApi

Create organization invitation

POST
/api/v1/auth/invitations

Authorization

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

organizationId*string
email*string
productRoles*array<>
membershipRole?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/auth/invitations" \  -H "Content-Type: application/json" \  -d '{    "organizationId": "string",    "email": "user@example.com",    "productRoles": [      "buyer"    ]  }'
{  "invitationId": "string",  "organizationId": "string",  "email": "user@example.com",  "productRoles": [    "buyer"  ],  "membershipRole": "owner",  "status": "pending",  "tokenPreview": "string",  "expiresAt": "string",  "createdAt": "string",  "invitationToken": "string"}
{  "type": "about:blank",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "requestId": "string",  "code": "string",  "errors": [    {      "detail": "string",      "pointer": "string"    }  ]}
{  "type": "about:blank",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "requestId": "string",  "code": "string"}
{  "type": "about:blank",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "requestId": "string",  "code": "string"}
{  "type": "about:blank",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "requestId": "string",  "code": "string"}
{  "type": "about:blank",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "requestId": "string",  "code": "string"}
{  "type": "about:blank",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "requestId": "string",  "code": "string"}