Nexus
Nexus APIs
POST
/v1/organizations/{organizationId}/aliases/{systemName}
Creates a new organization alias
Requires the organization.update permission
Parameters
| Name | In | Required | Description |
|---|---|---|---|
organizationId |
path | Yes | — |
systemName |
path | Yes | — |
Request body
Request payload
Example
{
"systemId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
systemId
|
string
|
required |
System id
minLength: 1 · maxLength: 255
|
— |
Example
{
"systemId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
systemId
|
string
|
required |
System id
minLength: 1 · maxLength: 255
|
— |
Example
{
"systemId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
systemId
|
string
|
required |
System id
minLength: 1 · maxLength: 255
|
— |
Example
{
"systemId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
systemId
|
string
|
required |
System id
minLength: 1 · maxLength: 255
|
— |
Example
{
"systemId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
systemId
|
string
|
required |
System id
minLength: 1 · maxLength: 255
|
— |
Example
{
"systemId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
systemId
|
string
|
required |
System id
minLength: 1 · maxLength: 255
|
— |
Example
{
"systemId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
systemId
|
string
|
required |
System id
minLength: 1 · maxLength: 255
|
— |
Example
{
"systemId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
systemId
|
string
|
required |
System id
minLength: 1 · maxLength: 255
|
— |
Responses
201
Example
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date the alias was created. | — |
organizationId
|
integer (int32)
|
nullable | The id of the organization. | — |
systemId
|
string
|
nullable | Id of the organization in the external system. | — |
systemName
|
string
|
nullable | The name external system. | — |
Example
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date the alias was created. | — |
organizationId
|
integer (int32)
|
nullable | The id of the organization. | — |
systemId
|
string
|
nullable | Id of the organization in the external system. | — |
systemName
|
string
|
nullable | The name external system. | — |
Example
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date the alias was created. | — |
organizationId
|
integer (int32)
|
nullable | The id of the organization. | — |
systemId
|
string
|
nullable | Id of the organization in the external system. | — |
systemName
|
string
|
nullable | The name external system. | — |
Example
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date the alias was created. | — |
organizationId
|
integer (int32)
|
nullable | The id of the organization. | — |
systemId
|
string
|
nullable | Id of the organization in the external system. | — |
systemName
|
string
|
nullable | The name external system. | — |
Example
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date the alias was created. | — |
organizationId
|
integer (int32)
|
nullable | The id of the organization. | — |
systemId
|
string
|
nullable | Id of the organization in the external system. | — |
systemName
|
string
|
nullable | The name external system. | — |
Example
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date the alias was created. | — |
organizationId
|
integer (int32)
|
nullable | The id of the organization. | — |
systemId
|
string
|
nullable | Id of the organization in the external system. | — |
systemName
|
string
|
nullable | The name external system. | — |
Example
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
created
|
string (date-time)
|
nullable | The date the alias was created. | — |
organizationId
|
integer (int32)
|
nullable | The id of the organization. | — |
systemId
|
string
|
nullable | Id of the organization in the external system. | — |
systemName
|
string
|
nullable | The name external system. | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic