Nexus
Nexus APIs
POST
/v1/organizations/{organizationId}/members/invite
Invite a user to this organization. If the user doesn't exist, they will be created. If the user already exists, they will be added as a member of the organization.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
organizationId |
path | Yes | The organization to invite the user to |
Request body
Request payload
Example
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailAddress
|
string
|
required |
The user's email address and sign-in name. This value must be unique across the entire system.
This value must adhere to the format 'user@domain'.
The email address is not verified unless requested.
minLength: 1 · maxLength: 250
|
— |
displayName
|
string
|
nullable |
A display name to use when showing the user information to admins and other users.
maxLength: 250
|
— |
familyName
|
string
|
nullable |
The users family or last name.
maxLength: 100
|
— |
givenName
|
string
|
nullable |
The users given or first name.
maxLength: 100
|
— |
isMfaDisabled
|
boolean
|
nullable | Indicates if the user is required to use multi-factor authentication. | — |
makeAdmin
|
boolean
|
nullable | If true, user will be assigned organization-admin role. | — |
Example
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailAddress
|
string
|
required |
The user's email address and sign-in name. This value must be unique across the entire system.
This value must adhere to the format 'user@domain'.
The email address is not verified unless requested.
minLength: 1 · maxLength: 250
|
— |
displayName
|
string
|
nullable |
A display name to use when showing the user information to admins and other users.
maxLength: 250
|
— |
familyName
|
string
|
nullable |
The users family or last name.
maxLength: 100
|
— |
givenName
|
string
|
nullable |
The users given or first name.
maxLength: 100
|
— |
isMfaDisabled
|
boolean
|
nullable | Indicates if the user is required to use multi-factor authentication. | — |
makeAdmin
|
boolean
|
nullable | If true, user will be assigned organization-admin role. | — |
Example
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailAddress
|
string
|
required |
The user's email address and sign-in name. This value must be unique across the entire system.
This value must adhere to the format 'user@domain'.
The email address is not verified unless requested.
minLength: 1 · maxLength: 250
|
— |
displayName
|
string
|
nullable |
A display name to use when showing the user information to admins and other users.
maxLength: 250
|
— |
familyName
|
string
|
nullable |
The users family or last name.
maxLength: 100
|
— |
givenName
|
string
|
nullable |
The users given or first name.
maxLength: 100
|
— |
isMfaDisabled
|
boolean
|
nullable | Indicates if the user is required to use multi-factor authentication. | — |
makeAdmin
|
boolean
|
nullable | If true, user will be assigned organization-admin role. | — |
Example
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailAddress
|
string
|
required |
The user's email address and sign-in name. This value must be unique across the entire system.
This value must adhere to the format 'user@domain'.
The email address is not verified unless requested.
minLength: 1 · maxLength: 250
|
— |
displayName
|
string
|
nullable |
A display name to use when showing the user information to admins and other users.
maxLength: 250
|
— |
familyName
|
string
|
nullable |
The users family or last name.
maxLength: 100
|
— |
givenName
|
string
|
nullable |
The users given or first name.
maxLength: 100
|
— |
isMfaDisabled
|
boolean
|
nullable | Indicates if the user is required to use multi-factor authentication. | — |
makeAdmin
|
boolean
|
nullable | If true, user will be assigned organization-admin role. | — |
Example
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailAddress
|
string
|
required |
The user's email address and sign-in name. This value must be unique across the entire system.
This value must adhere to the format 'user@domain'.
The email address is not verified unless requested.
minLength: 1 · maxLength: 250
|
— |
displayName
|
string
|
nullable |
A display name to use when showing the user information to admins and other users.
maxLength: 250
|
— |
familyName
|
string
|
nullable |
The users family or last name.
maxLength: 100
|
— |
givenName
|
string
|
nullable |
The users given or first name.
maxLength: 100
|
— |
isMfaDisabled
|
boolean
|
nullable | Indicates if the user is required to use multi-factor authentication. | — |
makeAdmin
|
boolean
|
nullable | If true, user will be assigned organization-admin role. | — |
Example
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailAddress
|
string
|
required |
The user's email address and sign-in name. This value must be unique across the entire system.
This value must adhere to the format 'user@domain'.
The email address is not verified unless requested.
minLength: 1 · maxLength: 250
|
— |
displayName
|
string
|
nullable |
A display name to use when showing the user information to admins and other users.
maxLength: 250
|
— |
familyName
|
string
|
nullable |
The users family or last name.
maxLength: 100
|
— |
givenName
|
string
|
nullable |
The users given or first name.
maxLength: 100
|
— |
isMfaDisabled
|
boolean
|
nullable | Indicates if the user is required to use multi-factor authentication. | — |
makeAdmin
|
boolean
|
nullable | If true, user will be assigned organization-admin role. | — |
Example
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailAddress
|
string
|
required |
The user's email address and sign-in name. This value must be unique across the entire system.
This value must adhere to the format 'user@domain'.
The email address is not verified unless requested.
minLength: 1 · maxLength: 250
|
— |
displayName
|
string
|
nullable |
A display name to use when showing the user information to admins and other users.
maxLength: 250
|
— |
familyName
|
string
|
nullable |
The users family or last name.
maxLength: 100
|
— |
givenName
|
string
|
nullable |
The users given or first name.
maxLength: 100
|
— |
isMfaDisabled
|
boolean
|
nullable | Indicates if the user is required to use multi-factor authentication. | — |
makeAdmin
|
boolean
|
nullable | If true, user will be assigned organization-admin role. | — |
Example
{
"givenName": "string",
"makeAdmin": false,
"familyName": "string",
"displayName": "string",
"emailAddress": "string",
"isMfaDisabled": false
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailAddress
|
string
|
required |
The user's email address and sign-in name. This value must be unique across the entire system.
This value must adhere to the format 'user@domain'.
The email address is not verified unless requested.
minLength: 1 · maxLength: 250
|
— |
displayName
|
string
|
nullable |
A display name to use when showing the user information to admins and other users.
maxLength: 250
|
— |
familyName
|
string
|
nullable |
The users family or last name.
maxLength: 100
|
— |
givenName
|
string
|
nullable |
The users given or first name.
maxLength: 100
|
— |
isMfaDisabled
|
boolean
|
nullable | Indicates if the user is required to use multi-factor authentication. | — |
makeAdmin
|
boolean
|
nullable | If true, user will be assigned organization-admin role. | — |
Responses
204
No Content
400
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
409
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic