Nexus
Nexus APIs
POST
/v1/roles
Creates a new developer role.
The role name will be automatically generated as "-developers".
Requires the role.write permission.
Request body
Request payload
Example
{
"audience": "string",
"description": "string",
"productName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
required |
The audience for the role (e.g., "https://api.ecinexus.com").
minLength: 1
|
— |
productName
|
string
|
required |
The product name. The role will be named "{ProductName}-developers".
minLength: 1
|
— |
description
|
string
|
nullable | An optional description of the role. | — |
Example
{
"audience": "string",
"description": "string",
"productName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
required |
The audience for the role (e.g., "https://api.ecinexus.com").
minLength: 1
|
— |
productName
|
string
|
required |
The product name. The role will be named "{ProductName}-developers".
minLength: 1
|
— |
description
|
string
|
nullable | An optional description of the role. | — |
Example
{
"audience": "string",
"description": "string",
"productName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
required |
The audience for the role (e.g., "https://api.ecinexus.com").
minLength: 1
|
— |
productName
|
string
|
required |
The product name. The role will be named "{ProductName}-developers".
minLength: 1
|
— |
description
|
string
|
nullable | An optional description of the role. | — |
Example
{
"audience": "string",
"description": "string",
"productName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
required |
The audience for the role (e.g., "https://api.ecinexus.com").
minLength: 1
|
— |
productName
|
string
|
required |
The product name. The role will be named "{ProductName}-developers".
minLength: 1
|
— |
description
|
string
|
nullable | An optional description of the role. | — |
Example
{
"audience": "string",
"description": "string",
"productName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
required |
The audience for the role (e.g., "https://api.ecinexus.com").
minLength: 1
|
— |
productName
|
string
|
required |
The product name. The role will be named "{ProductName}-developers".
minLength: 1
|
— |
description
|
string
|
nullable | An optional description of the role. | — |
Example
{
"audience": "string",
"description": "string",
"productName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
required |
The audience for the role (e.g., "https://api.ecinexus.com").
minLength: 1
|
— |
productName
|
string
|
required |
The product name. The role will be named "{ProductName}-developers".
minLength: 1
|
— |
description
|
string
|
nullable | An optional description of the role. | — |
Example
{
"audience": "string",
"description": "string",
"productName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
required |
The audience for the role (e.g., "https://api.ecinexus.com").
minLength: 1
|
— |
productName
|
string
|
required |
The product name. The role will be named "{ProductName}-developers".
minLength: 1
|
— |
description
|
string
|
nullable | An optional description of the role. | — |
Example
{
"audience": "string",
"description": "string",
"productName": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
required |
The audience for the role (e.g., "https://api.ecinexus.com").
minLength: 1
|
— |
productName
|
string
|
required |
The product name. The role will be named "{ProductName}-developers".
minLength: 1
|
— |
description
|
string
|
nullable | An optional description of the role. | — |
Responses
201
Example
{
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [
{
"code": "string",
"roleId": "string",
"permissionId": 0
}
],
"connectionMaps": [
{
"id": 0,
"name": "string",
"role": {
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [],
"connectionMaps": []
},
"roleId": "string",
"groupName": "string",
"azoConnectionId": "string"
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
nullable | A audience of the role. | — |
connectionMaps
|
nullable | — | — | |
description
|
string
|
nullable | A description of the role. | — |
id
|
string
|
nullable | The unique id of the role | — |
name
|
string
|
nullable | The unique name of the role. | — |
permissions
|
nullable | Permissions assigned to the role. | — |
Example
{
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [
{
"code": "string",
"roleId": "string",
"permissionId": 0
}
],
"connectionMaps": [
{
"id": 0,
"name": "string",
"role": {
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [],
"connectionMaps": []
},
"roleId": "string",
"groupName": "string",
"azoConnectionId": "string"
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
nullable | A audience of the role. | — |
connectionMaps
|
nullable | — | — | |
description
|
string
|
nullable | A description of the role. | — |
id
|
string
|
nullable | The unique id of the role | — |
name
|
string
|
nullable | The unique name of the role. | — |
permissions
|
nullable | Permissions assigned to the role. | — |
Example
{
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [
{
"code": "string",
"roleId": "string",
"permissionId": 0
}
],
"connectionMaps": [
{
"id": 0,
"name": "string",
"role": {
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [],
"connectionMaps": []
},
"roleId": "string",
"groupName": "string",
"azoConnectionId": "string"
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
nullable | A audience of the role. | — |
connectionMaps
|
nullable | — | — | |
description
|
string
|
nullable | A description of the role. | — |
id
|
string
|
nullable | The unique id of the role | — |
name
|
string
|
nullable | The unique name of the role. | — |
permissions
|
nullable | Permissions assigned to the role. | — |
Example
{
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [
{
"code": "string",
"roleId": "string",
"permissionId": 0
}
],
"connectionMaps": [
{
"id": 0,
"name": "string",
"role": {
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [],
"connectionMaps": []
},
"roleId": "string",
"groupName": "string",
"azoConnectionId": "string"
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
nullable | A audience of the role. | — |
connectionMaps
|
nullable | — | — | |
description
|
string
|
nullable | A description of the role. | — |
id
|
string
|
nullable | The unique id of the role | — |
name
|
string
|
nullable | The unique name of the role. | — |
permissions
|
nullable | Permissions assigned to the role. | — |
Example
{
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [
{
"code": "string",
"roleId": "string",
"permissionId": 0
}
],
"connectionMaps": [
{
"id": 0,
"name": "string",
"role": {
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [],
"connectionMaps": []
},
"roleId": "string",
"groupName": "string",
"azoConnectionId": "string"
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
nullable | A audience of the role. | — |
connectionMaps
|
nullable | — | — | |
description
|
string
|
nullable | A description of the role. | — |
id
|
string
|
nullable | The unique id of the role | — |
name
|
string
|
nullable | The unique name of the role. | — |
permissions
|
nullable | Permissions assigned to the role. | — |
Example
{
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [
{
"code": "string",
"roleId": "string",
"permissionId": 0
}
],
"connectionMaps": [
{
"id": 0,
"name": "string",
"role": {
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [],
"connectionMaps": []
},
"roleId": "string",
"groupName": "string",
"azoConnectionId": "string"
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
nullable | A audience of the role. | — |
connectionMaps
|
nullable | — | — | |
description
|
string
|
nullable | A description of the role. | — |
id
|
string
|
nullable | The unique id of the role | — |
name
|
string
|
nullable | The unique name of the role. | — |
permissions
|
nullable | Permissions assigned to the role. | — |
Example
{
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [
{
"code": "string",
"roleId": "string",
"permissionId": 0
}
],
"connectionMaps": [
{
"id": 0,
"name": "string",
"role": {
"id": "string",
"name": "string",
"audience": "string",
"description": "string",
"permissions": [],
"connectionMaps": []
},
"roleId": "string",
"groupName": "string",
"azoConnectionId": "string"
}
]
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
audience
|
string
|
nullable | A audience of the role. | — |
connectionMaps
|
nullable | — | — | |
description
|
string
|
nullable | A description of the role. | — |
id
|
string
|
nullable | The unique id of the role | — |
name
|
string
|
nullable | The unique name of the role. | — |
permissions
|
nullable | Permissions assigned to the role. | — |
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