Skip to main content
Invite one organization member through the configured identity provider

Authorizations

Authorization
string
header
required

Opaque control credential

Headers

Idempotency-Key
string
required
Required string length: 8 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Body

application/json
email
string<email>
required
Maximum string length: 320
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Response

Existing idempotent organization invitation

schemaVersion
enum<number>
required
Available options:
1
invitationId
string
required
Pattern: ^oinv_[0-9a-z]{12,32}$
email
string<email>
required
Maximum string length: 320
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
role
enum<string>
required
Available options:
member
state
enum<string>
required
Available options:
pending,
accepted,
expired,
revoked
inviterUserId
string
required
Pattern: ^usr_[0-9a-z]{12,32}$
expiresAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
createdAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updatedAtMs
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
acceptedUserId
string
Pattern: ^usr_[0-9a-z]{12,32}$
acceptedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991
revokedAtMs
integer
Required range: -9007199254740991 <= x <= 9007199254740991