Nexus
Nexus APIs
PUT
/v1/users/{userId}/idp_tenants/{idpTenantId}
LinkUserToTenant
Parameters
| Name | In | Required | Description |
|---|---|---|---|
userId |
path | Yes | — |
idpTenantId |
path | Yes | — |
Request body
Request payload
Example
{
"strategy": "string",
"azoUserId": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
required |
The unique ID or Name of the connection.
minLength: 1 · maxLength: 50
|
— |
azoUserId
|
string
|
required |
This value should only be set when creating a Nexus user that already exists in the Auth0 tenant.
This value should only be provided if you are creating a user that already
exists in the associated Tenant but does not in Nexus.
minLength: 1 · maxLength: 250
|
— |
strategy
|
string
|
required |
The auth0 connection strategy for the identity
minLength: 1 · maxLength: 25
|
— |
Example
{
"strategy": "string",
"azoUserId": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
required |
The unique ID or Name of the connection.
minLength: 1 · maxLength: 50
|
— |
azoUserId
|
string
|
required |
This value should only be set when creating a Nexus user that already exists in the Auth0 tenant.
This value should only be provided if you are creating a user that already
exists in the associated Tenant but does not in Nexus.
minLength: 1 · maxLength: 250
|
— |
strategy
|
string
|
required |
The auth0 connection strategy for the identity
minLength: 1 · maxLength: 25
|
— |
Example
{
"strategy": "string",
"azoUserId": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
required |
The unique ID or Name of the connection.
minLength: 1 · maxLength: 50
|
— |
azoUserId
|
string
|
required |
This value should only be set when creating a Nexus user that already exists in the Auth0 tenant.
This value should only be provided if you are creating a user that already
exists in the associated Tenant but does not in Nexus.
minLength: 1 · maxLength: 250
|
— |
strategy
|
string
|
required |
The auth0 connection strategy for the identity
minLength: 1 · maxLength: 25
|
— |
Example
{
"strategy": "string",
"azoUserId": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
required |
The unique ID or Name of the connection.
minLength: 1 · maxLength: 50
|
— |
azoUserId
|
string
|
required |
This value should only be set when creating a Nexus user that already exists in the Auth0 tenant.
This value should only be provided if you are creating a user that already
exists in the associated Tenant but does not in Nexus.
minLength: 1 · maxLength: 250
|
— |
strategy
|
string
|
required |
The auth0 connection strategy for the identity
minLength: 1 · maxLength: 25
|
— |
Example
{
"strategy": "string",
"azoUserId": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
required |
The unique ID or Name of the connection.
minLength: 1 · maxLength: 50
|
— |
azoUserId
|
string
|
required |
This value should only be set when creating a Nexus user that already exists in the Auth0 tenant.
This value should only be provided if you are creating a user that already
exists in the associated Tenant but does not in Nexus.
minLength: 1 · maxLength: 250
|
— |
strategy
|
string
|
required |
The auth0 connection strategy for the identity
minLength: 1 · maxLength: 25
|
— |
Example
{
"strategy": "string",
"azoUserId": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
required |
The unique ID or Name of the connection.
minLength: 1 · maxLength: 50
|
— |
azoUserId
|
string
|
required |
This value should only be set when creating a Nexus user that already exists in the Auth0 tenant.
This value should only be provided if you are creating a user that already
exists in the associated Tenant but does not in Nexus.
minLength: 1 · maxLength: 250
|
— |
strategy
|
string
|
required |
The auth0 connection strategy for the identity
minLength: 1 · maxLength: 25
|
— |
Example
{
"strategy": "string",
"azoUserId": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
required |
The unique ID or Name of the connection.
minLength: 1 · maxLength: 50
|
— |
azoUserId
|
string
|
required |
This value should only be set when creating a Nexus user that already exists in the Auth0 tenant.
This value should only be provided if you are creating a user that already
exists in the associated Tenant but does not in Nexus.
minLength: 1 · maxLength: 250
|
— |
strategy
|
string
|
required |
The auth0 connection strategy for the identity
minLength: 1 · maxLength: 25
|
— |
Example
{
"strategy": "string",
"azoUserId": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
required |
The unique ID or Name of the connection.
minLength: 1 · maxLength: 50
|
— |
azoUserId
|
string
|
required |
This value should only be set when creating a Nexus user that already exists in the Auth0 tenant.
This value should only be provided if you are creating a user that already
exists in the associated Tenant but does not in Nexus.
minLength: 1 · maxLength: 250
|
— |
strategy
|
string
|
required |
The auth0 connection strategy for the identity
minLength: 1 · maxLength: 25
|
— |
Responses
200
Example
{
"id": 0,
"groups": [
{
"id": 0,
"expires": "string",
"groupName": "string",
"identityId": 0,
"userIdentityId": 0
}
],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
nullable | The Auth0 connection associated with the user. | — |
azoTenantName
|
string
|
nullable | The azoName of the tenant. | — |
azoUserId
|
string
|
nullable | The Auth0 assinged unique id for the user. This value may only be unique in a single tenant. | — |
groups
|
nullable | — | — | |
id
|
integer (int32)
|
nullable | The id | — |
idpTenantFqdn
|
string
|
nullable | The FQDN of the tenant. | — |
idpTenantId
|
integer (int32)
|
nullable | The IdP tenant to which this user belongs. | — |
idpTenantName
|
string
|
nullable | The unique name of the tenant. | — |
loginDomain
|
string
|
nullable | The login domain name of the tenant. | — |
strategy
|
string
|
nullable | Gets the identity login strategy. | — |
Example
{
"id": 0,
"groups": [
{
"id": 0,
"expires": "string",
"groupName": "string",
"identityId": 0,
"userIdentityId": 0
}
],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
nullable | The Auth0 connection associated with the user. | — |
azoTenantName
|
string
|
nullable | The azoName of the tenant. | — |
azoUserId
|
string
|
nullable | The Auth0 assinged unique id for the user. This value may only be unique in a single tenant. | — |
groups
|
nullable | — | — | |
id
|
integer (int32)
|
nullable | The id | — |
idpTenantFqdn
|
string
|
nullable | The FQDN of the tenant. | — |
idpTenantId
|
integer (int32)
|
nullable | The IdP tenant to which this user belongs. | — |
idpTenantName
|
string
|
nullable | The unique name of the tenant. | — |
loginDomain
|
string
|
nullable | The login domain name of the tenant. | — |
strategy
|
string
|
nullable | Gets the identity login strategy. | — |
Example
{
"id": 0,
"groups": [
{
"id": 0,
"expires": "string",
"groupName": "string",
"identityId": 0,
"userIdentityId": 0
}
],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
nullable | The Auth0 connection associated with the user. | — |
azoTenantName
|
string
|
nullable | The azoName of the tenant. | — |
azoUserId
|
string
|
nullable | The Auth0 assinged unique id for the user. This value may only be unique in a single tenant. | — |
groups
|
nullable | — | — | |
id
|
integer (int32)
|
nullable | The id | — |
idpTenantFqdn
|
string
|
nullable | The FQDN of the tenant. | — |
idpTenantId
|
integer (int32)
|
nullable | The IdP tenant to which this user belongs. | — |
idpTenantName
|
string
|
nullable | The unique name of the tenant. | — |
loginDomain
|
string
|
nullable | The login domain name of the tenant. | — |
strategy
|
string
|
nullable | Gets the identity login strategy. | — |
Example
{
"id": 0,
"groups": [
{
"id": 0,
"expires": "string",
"groupName": "string",
"identityId": 0,
"userIdentityId": 0
}
],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
nullable | The Auth0 connection associated with the user. | — |
azoTenantName
|
string
|
nullable | The azoName of the tenant. | — |
azoUserId
|
string
|
nullable | The Auth0 assinged unique id for the user. This value may only be unique in a single tenant. | — |
groups
|
nullable | — | — | |
id
|
integer (int32)
|
nullable | The id | — |
idpTenantFqdn
|
string
|
nullable | The FQDN of the tenant. | — |
idpTenantId
|
integer (int32)
|
nullable | The IdP tenant to which this user belongs. | — |
idpTenantName
|
string
|
nullable | The unique name of the tenant. | — |
loginDomain
|
string
|
nullable | The login domain name of the tenant. | — |
strategy
|
string
|
nullable | Gets the identity login strategy. | — |
Example
{
"id": 0,
"groups": [
{
"id": 0,
"expires": "string",
"groupName": "string",
"identityId": 0,
"userIdentityId": 0
}
],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
nullable | The Auth0 connection associated with the user. | — |
azoTenantName
|
string
|
nullable | The azoName of the tenant. | — |
azoUserId
|
string
|
nullable | The Auth0 assinged unique id for the user. This value may only be unique in a single tenant. | — |
groups
|
nullable | — | — | |
id
|
integer (int32)
|
nullable | The id | — |
idpTenantFqdn
|
string
|
nullable | The FQDN of the tenant. | — |
idpTenantId
|
integer (int32)
|
nullable | The IdP tenant to which this user belongs. | — |
idpTenantName
|
string
|
nullable | The unique name of the tenant. | — |
loginDomain
|
string
|
nullable | The login domain name of the tenant. | — |
strategy
|
string
|
nullable | Gets the identity login strategy. | — |
Example
{
"id": 0,
"groups": [
{
"id": 0,
"expires": "string",
"groupName": "string",
"identityId": 0,
"userIdentityId": 0
}
],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
nullable | The Auth0 connection associated with the user. | — |
azoTenantName
|
string
|
nullable | The azoName of the tenant. | — |
azoUserId
|
string
|
nullable | The Auth0 assinged unique id for the user. This value may only be unique in a single tenant. | — |
groups
|
nullable | — | — | |
id
|
integer (int32)
|
nullable | The id | — |
idpTenantFqdn
|
string
|
nullable | The FQDN of the tenant. | — |
idpTenantId
|
integer (int32)
|
nullable | The IdP tenant to which this user belongs. | — |
idpTenantName
|
string
|
nullable | The unique name of the tenant. | — |
loginDomain
|
string
|
nullable | The login domain name of the tenant. | — |
strategy
|
string
|
nullable | Gets the identity login strategy. | — |
Example
{
"id": 0,
"groups": [
{
"id": 0,
"expires": "string",
"groupName": "string",
"identityId": 0,
"userIdentityId": 0
}
],
"strategy": "string",
"azoUserId": "string",
"idpTenantId": 0,
"loginDomain": "string",
"azoTenantName": "string",
"idpTenantFqdn": "string",
"idpTenantName": "string",
"azoConnectionId": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
azoConnectionId
|
string
|
nullable | The Auth0 connection associated with the user. | — |
azoTenantName
|
string
|
nullable | The azoName of the tenant. | — |
azoUserId
|
string
|
nullable | The Auth0 assinged unique id for the user. This value may only be unique in a single tenant. | — |
groups
|
nullable | — | — | |
id
|
integer (int32)
|
nullable | The id | — |
idpTenantFqdn
|
string
|
nullable | The FQDN of the tenant. | — |
idpTenantId
|
integer (int32)
|
nullable | The IdP tenant to which this user belongs. | — |
idpTenantName
|
string
|
nullable | The unique name of the tenant. | — |
loginDomain
|
string
|
nullable | The login domain name of the tenant. | — |
strategy
|
string
|
nullable | Gets the identity login strategy. | — |
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