Nexus
Nexus APIs
POST
/v1/organizations/{organizationId}/domains
Creates an organization domain
Parameters
| Name | In | Required | Description |
|---|---|---|---|
organizationId |
path | Yes |
Request body
Request payload
Example
{
"domain": "string",
"domainSource": "string",
"verificationMethod": "string",
"authenticationMethod": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
required |
—
minLength: 1
|
— |
domain
|
string
|
required |
—
minLength: 1
|
— |
verificationMethod
|
string
|
required |
—
minLength: 1
|
— |
domainSource
|
string
|
nullable | The source that initiated the domain creation (readonly after construction) | — |
Example
{
"domain": "string",
"domainSource": "string",
"verificationMethod": "string",
"authenticationMethod": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
required |
—
minLength: 1
|
— |
domain
|
string
|
required |
—
minLength: 1
|
— |
verificationMethod
|
string
|
required |
—
minLength: 1
|
— |
domainSource
|
string
|
nullable | The source that initiated the domain creation (readonly after construction) | — |
Example
{
"domain": "string",
"domainSource": "string",
"verificationMethod": "string",
"authenticationMethod": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
required |
—
minLength: 1
|
— |
domain
|
string
|
required |
—
minLength: 1
|
— |
verificationMethod
|
string
|
required |
—
minLength: 1
|
— |
domainSource
|
string
|
nullable | The source that initiated the domain creation (readonly after construction) | — |
Example
{
"domain": "string",
"domainSource": "string",
"verificationMethod": "string",
"authenticationMethod": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
required |
—
minLength: 1
|
— |
domain
|
string
|
required |
—
minLength: 1
|
— |
verificationMethod
|
string
|
required |
—
minLength: 1
|
— |
domainSource
|
string
|
nullable | The source that initiated the domain creation (readonly after construction) | — |
Example
{
"domain": "string",
"domainSource": "string",
"verificationMethod": "string",
"authenticationMethod": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
required |
—
minLength: 1
|
— |
domain
|
string
|
required |
—
minLength: 1
|
— |
verificationMethod
|
string
|
required |
—
minLength: 1
|
— |
domainSource
|
string
|
nullable | The source that initiated the domain creation (readonly after construction) | — |
Example
{
"domain": "string",
"domainSource": "string",
"verificationMethod": "string",
"authenticationMethod": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
required |
—
minLength: 1
|
— |
domain
|
string
|
required |
—
minLength: 1
|
— |
verificationMethod
|
string
|
required |
—
minLength: 1
|
— |
domainSource
|
string
|
nullable | The source that initiated the domain creation (readonly after construction) | — |
Example
{
"domain": "string",
"domainSource": "string",
"verificationMethod": "string",
"authenticationMethod": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
required |
—
minLength: 1
|
— |
domain
|
string
|
required |
—
minLength: 1
|
— |
verificationMethod
|
string
|
required |
—
minLength: 1
|
— |
domainSource
|
string
|
nullable | The source that initiated the domain creation (readonly after construction) | — |
Example
{
"domain": "string",
"domainSource": "string",
"verificationMethod": "string",
"authenticationMethod": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
required |
—
minLength: 1
|
— |
domain
|
string
|
required |
—
minLength: 1
|
— |
verificationMethod
|
string
|
required |
—
minLength: 1
|
— |
domainSource
|
string
|
nullable | The source that initiated the domain creation (readonly after construction) | — |
Responses
201
Example
{
"domain": "string",
"created": "string",
"domainId": 0,
"modified": "string",
"createdBy": "string",
"isVerified": false,
"modifiedBy": "string",
"organizationId": 0,
"verificationCode": "string",
"verificationMethod": "string",
"ownerOrganizationId": 0,
"authenticationMethod": "string",
"verificationCodeExpires": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
domain
|
string
|
nullable | — | — |
domainId
|
integer (int32)
|
nullable | — | — |
isVerified
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
organizationId
|
integer (int32)
|
nullable | — | — |
ownerOrganizationId
|
integer (int32)
|
nullable | — | — |
verificationCode
|
string
|
nullable | — | — |
verificationCodeExpires
|
string (date-time)
|
nullable | — | — |
verificationMethod
|
string
|
nullable | — | — |
Example
{
"domain": "string",
"created": "string",
"domainId": 0,
"modified": "string",
"createdBy": "string",
"isVerified": false,
"modifiedBy": "string",
"organizationId": 0,
"verificationCode": "string",
"verificationMethod": "string",
"ownerOrganizationId": 0,
"authenticationMethod": "string",
"verificationCodeExpires": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
domain
|
string
|
nullable | — | — |
domainId
|
integer (int32)
|
nullable | — | — |
isVerified
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
organizationId
|
integer (int32)
|
nullable | — | — |
ownerOrganizationId
|
integer (int32)
|
nullable | — | — |
verificationCode
|
string
|
nullable | — | — |
verificationCodeExpires
|
string (date-time)
|
nullable | — | — |
verificationMethod
|
string
|
nullable | — | — |
Example
{
"domain": "string",
"created": "string",
"domainId": 0,
"modified": "string",
"createdBy": "string",
"isVerified": false,
"modifiedBy": "string",
"organizationId": 0,
"verificationCode": "string",
"verificationMethod": "string",
"ownerOrganizationId": 0,
"authenticationMethod": "string",
"verificationCodeExpires": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
domain
|
string
|
nullable | — | — |
domainId
|
integer (int32)
|
nullable | — | — |
isVerified
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
organizationId
|
integer (int32)
|
nullable | — | — |
ownerOrganizationId
|
integer (int32)
|
nullable | — | — |
verificationCode
|
string
|
nullable | — | — |
verificationCodeExpires
|
string (date-time)
|
nullable | — | — |
verificationMethod
|
string
|
nullable | — | — |
Example
{
"domain": "string",
"created": "string",
"domainId": 0,
"modified": "string",
"createdBy": "string",
"isVerified": false,
"modifiedBy": "string",
"organizationId": 0,
"verificationCode": "string",
"verificationMethod": "string",
"ownerOrganizationId": 0,
"authenticationMethod": "string",
"verificationCodeExpires": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
domain
|
string
|
nullable | — | — |
domainId
|
integer (int32)
|
nullable | — | — |
isVerified
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
organizationId
|
integer (int32)
|
nullable | — | — |
ownerOrganizationId
|
integer (int32)
|
nullable | — | — |
verificationCode
|
string
|
nullable | — | — |
verificationCodeExpires
|
string (date-time)
|
nullable | — | — |
verificationMethod
|
string
|
nullable | — | — |
Example
{
"domain": "string",
"created": "string",
"domainId": 0,
"modified": "string",
"createdBy": "string",
"isVerified": false,
"modifiedBy": "string",
"organizationId": 0,
"verificationCode": "string",
"verificationMethod": "string",
"ownerOrganizationId": 0,
"authenticationMethod": "string",
"verificationCodeExpires": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
domain
|
string
|
nullable | — | — |
domainId
|
integer (int32)
|
nullable | — | — |
isVerified
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
organizationId
|
integer (int32)
|
nullable | — | — |
ownerOrganizationId
|
integer (int32)
|
nullable | — | — |
verificationCode
|
string
|
nullable | — | — |
verificationCodeExpires
|
string (date-time)
|
nullable | — | — |
verificationMethod
|
string
|
nullable | — | — |
Example
{
"domain": "string",
"created": "string",
"domainId": 0,
"modified": "string",
"createdBy": "string",
"isVerified": false,
"modifiedBy": "string",
"organizationId": 0,
"verificationCode": "string",
"verificationMethod": "string",
"ownerOrganizationId": 0,
"authenticationMethod": "string",
"verificationCodeExpires": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
domain
|
string
|
nullable | — | — |
domainId
|
integer (int32)
|
nullable | — | — |
isVerified
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
organizationId
|
integer (int32)
|
nullable | — | — |
ownerOrganizationId
|
integer (int32)
|
nullable | — | — |
verificationCode
|
string
|
nullable | — | — |
verificationCodeExpires
|
string (date-time)
|
nullable | — | — |
verificationMethod
|
string
|
nullable | — | — |
Example
{
"domain": "string",
"created": "string",
"domainId": 0,
"modified": "string",
"createdBy": "string",
"isVerified": false,
"modifiedBy": "string",
"organizationId": 0,
"verificationCode": "string",
"verificationMethod": "string",
"ownerOrganizationId": 0,
"authenticationMethod": "string",
"verificationCodeExpires": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
authenticationMethod
|
string
|
nullable | — | — |
created
|
string (date-time)
|
nullable | — | — |
createdBy
|
string
|
nullable | — | — |
domain
|
string
|
nullable | — | — |
domainId
|
integer (int32)
|
nullable | — | — |
isVerified
|
boolean
|
nullable | — | — |
modified
|
string (date-time)
|
nullable | — | — |
modifiedBy
|
string
|
nullable | — | — |
organizationId
|
integer (int32)
|
nullable | — | — |
ownerOrganizationId
|
integer (int32)
|
nullable | — | — |
verificationCode
|
string
|
nullable | — | — |
verificationCodeExpires
|
string (date-time)
|
nullable | — | — |
verificationMethod
|
string
|
nullable | — | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic