OrkStageOrkStage
API referenceTenants and plans

POST /tenants/{tenantId}/invitations

POST /tenants/{tenantId}/invitations: OrkStage Control API v1 endpoint reference.

POST
/api/v1/tenants/{tenantId}/invitations

Authorization

headerAuthorizationBearer <token>

Organization API key (scoped). Sessions use the cookie instead.

Path Parameters

tenantId*string

Header Parameters

x-orkstage-csrf?unknown

Cookie sessions: send "1" on POST/PATCH/PUT/DELETE. Not needed with an API key.

Request Body

application/json
  1. body
email*string
Match^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
Lengthlength <= 254
role*string
Value in"CustomerOwner""CustomerAdmin""CustomerDeveloper""CustomerViewer"

Response Body

curl -X POST 'http://localhost:4300/api/v1/tenants/string/invitations' \  -H 'Content-Type: application/json' \  -d '{  "email": "user@example.com",  "role": "CustomerOwner"}'
Empty
Edit on GitHub

GET /tenants/{tenantId}/members GET

GET /tenants/{tenantId}/members: OrkStage Control API v1 endpoint reference.

DELETE /tenants/{tenantId}/invitations/{id} DELETE

DELETE /tenants/{tenantId}/invitations/{id}: OrkStage Control API v1 endpoint reference.