Nexus
Nexus APIs
PATCH
/v1/users/{userId}/custom-upns/{upnId}
Updates the given properties on a Custom UPN.
This will update a custom UPN on the user's account and may prevent this user from logging in to applications that depend on it's presence.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
userId |
path | Yes | — |
upnId |
path | Yes | — |
Request body
Request payload
Example
{
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
Example
{
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
Example
{
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
Example
{
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
Example
{
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
Example
{
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
Example
{
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
Example
{
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
Responses
200
Example
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
created
|
string (date-time)
|
nullable | The date and time the custom UPN was created. | — |
createdBy
|
string
|
nullable | The user that created the custom UPN. | — |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
id
|
string
|
nullable | The unique ID of the custom UPN. | — |
modified
|
string (date-time)
|
nullable | The date and time the custom UPN was last modified. | — |
modifiedBy
|
string
|
nullable | The user that last modified the custom UPN. | — |
userId
|
string
|
nullable | The user ID associated with the custom UPN. | — |
Example
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
created
|
string (date-time)
|
nullable | The date and time the custom UPN was created. | — |
createdBy
|
string
|
nullable | The user that created the custom UPN. | — |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
id
|
string
|
nullable | The unique ID of the custom UPN. | — |
modified
|
string (date-time)
|
nullable | The date and time the custom UPN was last modified. | — |
modifiedBy
|
string
|
nullable | The user that last modified the custom UPN. | — |
userId
|
string
|
nullable | The user ID associated with the custom UPN. | — |
Example
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
created
|
string (date-time)
|
nullable | The date and time the custom UPN was created. | — |
createdBy
|
string
|
nullable | The user that created the custom UPN. | — |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
id
|
string
|
nullable | The unique ID of the custom UPN. | — |
modified
|
string (date-time)
|
nullable | The date and time the custom UPN was last modified. | — |
modifiedBy
|
string
|
nullable | The user that last modified the custom UPN. | — |
userId
|
string
|
nullable | The user ID associated with the custom UPN. | — |
Example
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
created
|
string (date-time)
|
nullable | The date and time the custom UPN was created. | — |
createdBy
|
string
|
nullable | The user that created the custom UPN. | — |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
id
|
string
|
nullable | The unique ID of the custom UPN. | — |
modified
|
string (date-time)
|
nullable | The date and time the custom UPN was last modified. | — |
modifiedBy
|
string
|
nullable | The user that last modified the custom UPN. | — |
userId
|
string
|
nullable | The user ID associated with the custom UPN. | — |
Example
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
created
|
string (date-time)
|
nullable | The date and time the custom UPN was created. | — |
createdBy
|
string
|
nullable | The user that created the custom UPN. | — |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
id
|
string
|
nullable | The unique ID of the custom UPN. | — |
modified
|
string (date-time)
|
nullable | The date and time the custom UPN was last modified. | — |
modifiedBy
|
string
|
nullable | The user that last modified the custom UPN. | — |
userId
|
string
|
nullable | The user ID associated with the custom UPN. | — |
Example
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
created
|
string (date-time)
|
nullable | The date and time the custom UPN was created. | — |
createdBy
|
string
|
nullable | The user that created the custom UPN. | — |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
id
|
string
|
nullable | The unique ID of the custom UPN. | — |
modified
|
string (date-time)
|
nullable | The date and time the custom UPN was last modified. | — |
modifiedBy
|
string
|
nullable | The user that last modified the custom UPN. | — |
userId
|
string
|
nullable | The user ID associated with the custom UPN. | — |
Example
{
"id": "string",
"userId": "string",
"created": "string",
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"clientUpnKey": "string",
"customUpnValue": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
clientUpnKey
|
string
|
nullable |
This value is used to associated a particular custom UPN with a specific Auth0 client.
The Auth0 client must specify the custom metadata property `app_upn_key` in order to link
use this custom UPN as the `upn` claim in the resulting ID Token.
maxLength: 255
|
— |
created
|
string (date-time)
|
nullable | The date and time the custom UPN was created. | — |
createdBy
|
string
|
nullable | The user that created the custom UPN. | — |
customUpnValue
|
string
|
nullable |
The custom UPN value. Must take the form of `user_part@domain_part`.
maxLength: 1024
|
— |
id
|
string
|
nullable | The unique ID of the custom UPN. | — |
modified
|
string (date-time)
|
nullable | The date and time the custom UPN was last modified. | — |
modifiedBy
|
string
|
nullable | The user that last modified the custom UPN. | — |
userId
|
string
|
nullable | The user ID associated with the custom UPN. | — |
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