Hanzo
OpenapiIam

Issues an invitation to join your organization — the code or link a new member…

Issues an invitation to join your organization — the code or link a new member redeems, with the role they arrive holding and the date it stops working.

POST /v1/iam/invitations

Addresshttps://api.hanzo.ai/v1/iam/invitations
MethodPOST
Operationpost_iam_invitations
AuthAuthorization: Bearer $HANZO_API_KEY

Issues an invitation to join your organization — the code or link a new member redeems, with the role they arrive holding and the date it stops working. A name already used in the organization is refused.

Request

16 fields, body application/json (required).

FieldInTypeRequiredDescription
applicationbodystring
codebodystring
createdTimebodystring
defaultCodebodystring
displayNamebodystring
emailbodystring
isRegexpbodyboolean
namebodystring
ownerbodystring
phonebodystring
quotabodyinteger
signupGroupbodystring
statebodystring
updatedTimebodystring
usedCountbodyinteger
usernamebodystring

Response

StatusBodyMeaning
200iam.Invitationok

200 body — 20 fields.

FieldInTypeAlwaysDescription
applicationbodystring
codebodystring
createdAtbodystring (date-time)
createdTimebodystring
defaultCodebodystring
deletedbodyboolean
displayNamebodystring
emailbodystring
idbodystring
isRegexpbodyboolean
namebodystring
ownerbodystring
phonebodystring
quotabodyinteger
signupGroupbodystring
statebodystring
updatedAtbodystring (date-time)
updatedTimebodystring
usedCountbodyinteger
usernamebodystring

Failure carries the platform error shape — see Errors.

Examples

hanzo iam invitations create

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page