Nexus
Nexus APIs
POST
/v1/me/mfa-enrollment
Creates an MFA enrollment for the current user
Parameters
| Name | In | Required | Description |
|---|---|---|---|
factor |
query | No | Optionally a specific factor to require for the enrollment. For example: if you want to request OTP MFA, pass `otp` as parameter |
isInteractive |
query | No | Determines if the request is interactive. If `true`, the API will return the URL to the enrollment flow directly, ideal for setting up MFA in a self-service environment. If `false`, we will send an email with the link to the MFA enrollment. This is used for management environments where users are requesting enrollment for other users. Defaults to `false` |
Responses
200
Example
{
"ticketId": "string",
"emailSent": false,
"ticketUrl": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailSent
|
boolean
|
— | Indicates if the end user was notified by email | — |
ticketId
|
string
|
nullable | The unique identifier of the ticket | — |
ticketUrl
|
string
|
nullable | The URL of the ticket that can be shared with the end user | — |
Example
{
"ticketId": "string",
"emailSent": false,
"ticketUrl": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailSent
|
boolean
|
— | Indicates if the end user was notified by email | — |
ticketId
|
string
|
nullable | The unique identifier of the ticket | — |
ticketUrl
|
string
|
nullable | The URL of the ticket that can be shared with the end user | — |
Example
{
"ticketId": "string",
"emailSent": false,
"ticketUrl": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailSent
|
boolean
|
— | Indicates if the end user was notified by email | — |
ticketId
|
string
|
nullable | The unique identifier of the ticket | — |
ticketUrl
|
string
|
nullable | The URL of the ticket that can be shared with the end user | — |
Example
{
"ticketId": "string",
"emailSent": false,
"ticketUrl": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailSent
|
boolean
|
— | Indicates if the end user was notified by email | — |
ticketId
|
string
|
nullable | The unique identifier of the ticket | — |
ticketUrl
|
string
|
nullable | The URL of the ticket that can be shared with the end user | — |
Example
{
"ticketId": "string",
"emailSent": false,
"ticketUrl": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailSent
|
boolean
|
— | Indicates if the end user was notified by email | — |
ticketId
|
string
|
nullable | The unique identifier of the ticket | — |
ticketUrl
|
string
|
nullable | The URL of the ticket that can be shared with the end user | — |
Example
{
"ticketId": "string",
"emailSent": false,
"ticketUrl": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailSent
|
boolean
|
— | Indicates if the end user was notified by email | — |
ticketId
|
string
|
nullable | The unique identifier of the ticket | — |
ticketUrl
|
string
|
nullable | The URL of the ticket that can be shared with the end user | — |
Example
{
"ticketId": "string",
"emailSent": false,
"ticketUrl": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
emailSent
|
boolean
|
— | Indicates if the end user was notified by email | — |
ticketId
|
string
|
nullable | The unique identifier of the ticket | — |
ticketUrl
|
string
|
nullable | The URL of the ticket that can be shared with the end user | — |
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 | — | — |
404
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