Hanzo
OpenapiIam

Returns one invitation: who it is for, what it grants on acceptance, and when…

Returns one invitation: who it is for, what it grants on acceptance, and when it expires.

POST /v1/iam/invitations/get

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

Returns one invitation: who it is for, what it grants on acceptance, and when it expires.

Request

2 fields, body application/json (required).

FieldInTypeRequiredDescription
namebodystring
ownerbodystring

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 get

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page