Invites
Invite a user to an organization with a role.
Authorizations
Path parameters
org_idstring · uuidrequired
The id of the org the user is being invited to
Query parameters
versionstringrequiredExample:
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Body
dataobjectrequired
Responses
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
post
201
400
401
403
404
500
List pending user invitations to an organization.
Authorizations
Path parameters
org_idstring · uuidrequired
The id of the org the user is being invited to
Query parameters
versionstringrequiredExample:
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
starting_afterstringoptionalExample:
Return the page of results immediately after this cursor
v1.eyJpZCI6IjEwMDAifQo=
ending_beforestringoptionalExample:
Return the page of results immediately before this cursor
v1.eyJpZCI6IjExMDAifQo=
limitinteger · int32 · min: 10 · max: 100optionalDefault:
Number of results to return per page
10
Example: 10
Responses
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
get
200
400
401
403
404
500
Cancel a pending user invitations to an organization.
Authorizations
Path parameters
org_idstring · uuidrequired
The id of the org the user is being invited to
invite_idstring · uuidrequired
The id of the pending invite to cancel
Query parameters
versionstringrequiredExample:
Requested API version
2021-06-04
Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$
Responses
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
application/vnd.api+json
delete
204
400
401
403
404
500
No Content
Last updated
Was this helpful?