Nexus
Nexus APIs
POST
/v1/sts-clients
Creates a new STS client mapping.
Maps an STS client ID to a user for authorization purposes. When an M2M token with this client ID is received, the mapped user's permissions will be used for authorization.
Request body
Request payload
Example
{
"clientId": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim, e.g., "myclient@clients"). | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
permissions
|
string
|
nullable | Permissions (space-delimited) to grant to this STS client. These are the only permissions the client will have - no inheritance from any user. | — |
Example
{
"clientId": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim, e.g., "myclient@clients"). | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
permissions
|
string
|
nullable | Permissions (space-delimited) to grant to this STS client. These are the only permissions the client will have - no inheritance from any user. | — |
Example
{
"clientId": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim, e.g., "myclient@clients"). | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
permissions
|
string
|
nullable | Permissions (space-delimited) to grant to this STS client. These are the only permissions the client will have - no inheritance from any user. | — |
Example
{
"clientId": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim, e.g., "myclient@clients"). | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
permissions
|
string
|
nullable | Permissions (space-delimited) to grant to this STS client. These are the only permissions the client will have - no inheritance from any user. | — |
Example
{
"clientId": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim, e.g., "myclient@clients"). | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
permissions
|
string
|
nullable | Permissions (space-delimited) to grant to this STS client. These are the only permissions the client will have - no inheritance from any user. | — |
Example
{
"clientId": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim, e.g., "myclient@clients"). | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
permissions
|
string
|
nullable | Permissions (space-delimited) to grant to this STS client. These are the only permissions the client will have - no inheritance from any user. | — |
Example
{
"clientId": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim, e.g., "myclient@clients"). | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
permissions
|
string
|
nullable | Permissions (space-delimited) to grant to this STS client. These are the only permissions the client will have - no inheritance from any user. | — |
Example
{
"clientId": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim, e.g., "myclient@clients"). | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
permissions
|
string
|
nullable | Permissions (space-delimited) to grant to this STS client. These are the only permissions the client will have - no inheritance from any user. | — |
Responses
201
Example
{
"userId": "string",
"created": "string",
"clientId": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim). | — |
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | Permissions (space-delimited) granted to this STS client. These are the only permissions the client will have. | — |
userId
|
string
|
nullable | The User ID of the creator. Used for audit/identity purposes only, not for permission inheritance. | — |
Example
{
"userId": "string",
"created": "string",
"clientId": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim). | — |
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | Permissions (space-delimited) granted to this STS client. These are the only permissions the client will have. | — |
userId
|
string
|
nullable | The User ID of the creator. Used for audit/identity purposes only, not for permission inheritance. | — |
Example
{
"userId": "string",
"created": "string",
"clientId": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim). | — |
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | Permissions (space-delimited) granted to this STS client. These are the only permissions the client will have. | — |
userId
|
string
|
nullable | The User ID of the creator. Used for audit/identity purposes only, not for permission inheritance. | — |
Example
{
"userId": "string",
"created": "string",
"clientId": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim). | — |
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | Permissions (space-delimited) granted to this STS client. These are the only permissions the client will have. | — |
userId
|
string
|
nullable | The User ID of the creator. Used for audit/identity purposes only, not for permission inheritance. | — |
Example
{
"userId": "string",
"created": "string",
"clientId": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim). | — |
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | Permissions (space-delimited) granted to this STS client. These are the only permissions the client will have. | — |
userId
|
string
|
nullable | The User ID of the creator. Used for audit/identity purposes only, not for permission inheritance. | — |
Example
{
"userId": "string",
"created": "string",
"clientId": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim). | — |
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | Permissions (space-delimited) granted to this STS client. These are the only permissions the client will have. | — |
userId
|
string
|
nullable | The User ID of the creator. Used for audit/identity purposes only, not for permission inheritance. | — |
Example
{
"userId": "string",
"created": "string",
"clientId": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"description": "string",
"permissions": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientId
|
string
|
nullable | The STS client identifier (from JWT cid or sub claim). | — |
created
|
string (date-time)
|
— | — | — |
createdBy
|
string
|
nullable | — | — |
description
|
string
|
nullable | Human-readable description of this client registration. | — |
modified
|
string (date-time)
|
— | — | — |
modifiedBy
|
string
|
nullable | — | — |
permissions
|
string
|
nullable | Permissions (space-delimited) granted to this STS client. These are the only permissions the client will have. | — |
userId
|
string
|
nullable | The User ID of the creator. Used for audit/identity purposes only, not for permission inheritance. | — |
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