Invite User

Invite a user

Invite a user to a tenant

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

Request Body schema: application/json
required
email
required
string <email> (email)
required
object (TenantUserInviteMeta)
connection_id
string (connection id)
Responses
201

Invite sent to user

400

tenant user invite create error

401

Unauthorized

post/authn2/v0/tenant/{enterprise_id}/invite
Request samples
application/json
{
  • "email": "user@example.com",
  • "meta": {
    },
  • "connection_id": "string"
}
Response samples
application/json
{
  • "id": "string",
  • "email": "user@example.com",
  • "tenant_id": "string",
  • "idp_invite_id": "string",
  • "meta": { },
  • "connection_id": "string",
  • "send_invitation_email": true,
  • "invitation_url": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z"
}

List user invites

List user invites in a tenant

SecurityapiKey
Request
path Parameters
enterprise_id
required
string <uuid>

Enterprise ID

Responses
201

Tenant user invites

400

List tenant user invites error

401

Unauthorized

get/authn2/v0/tenant/{enterprise_id}/invite
Request samples
Response samples
application/json
{
  • "count": 0,
  • "userinvites": [
    ]
}