Create an Invitation
POST/iam/v2/invitations
Make a request to create an invitation.
The newly invited user will not have any permissions. Give the user permission by assigning them to one or
more roles by creating
role bindings
for the created user.
Request
Responses
- 201
- 400
- 401
- 402
- 403
- 409
- 422
- 429
- 500
An Invitation was created.
Response Headers
The unique identifier for the API request.
The maximum number of requests you're permitted to make per time period.
The number of requests remaining in the current rate limit window.
The relative time in seconds until the current rate-limit window resets.
Important: This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues.
Invitation resource uri
Bad Request
Response Headers
The unique identifier for the API request.
The request lacks valid authentication credentials for this resource.
Response Headers
The unique identifier for the API request.
The unique identifier for the API request.
Basic error="invalid_key", error_description="The API Key is invalid"The request would exceed one or more quotas.
Response Headers
The unique identifier for the API request.
The access credentials were considered insufficient to grant access
Response Headers
The unique identifier for the API request.
The request is in conflict with the current server state
Response Headers
The unique identifier for the API request.
Resource URI of conflicting resource
Validation Failed
Response Headers
The unique identifier for the API request.
Rate Limit Exceeded
Response Headers
The unique identifier for the API request.
The maximum number of requests you're permitted to make per time period.
The number of requests remaining in the current rate limit window.
The relative time in seconds until the current rate-limit window resets.
Important: This differs from Github and Twitter's same-named header which uses UTC epoch seconds. We use relative time to avoid client/server time synchronization issues.
The number of seconds to wait until the rate limit window resets. Only sent when the rate limit is reached.
Oops, something went wrong!
Response Headers
The unique identifier for the API request.