Nexus

Nexus APIs

GET /v1/tenants/{tenantId}

Gets a single Tenant by Id.

Parameters
Name In Required Description
tenantId path Yes
Responses
200
Example 
{
  "id": 0,
  "fqdn": "string",
  "name": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "clients": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "mobile": {
        "ios": null,
        "android": null
      },
      "owners": [
        "string"
      ],
      "secret": "string",
      "logoUrl": "string",
      "grantTypes": [
        "string"
      ],
      "productName": "string",
      "callbackUrls": [
        "string"
      ],
      "client_upn_key": "string",
      "applicationName": "string",
      "manuallyCreated": false,
      "clientAuthMethod": "string",
      "allowedLogoutUrls": [
        "string"
      ],
      "allowedWebOrigins": [
        "string"
      ],
      "idTokenExpiration": 0,
      "allowedCorsOrigins": [
        "string"
      ],
      "refreshTokenReuseInterval": 0,
      "refreshTokenAbsoluteLifetime": 0,
      "isRefreshTokenRotationEnabled": false,
      "allowCrossOriginAuthentication": false,
      "refreshTokenInactivityLifetime": 0,
      "isRefreshTokenAbsoluteExpirationEnabled": false,
      "isRefreshTokenInactivityLifetimeEnabled": false
    }
  ],
  "created": "string",
  "isActive": false,
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "connections": [
    {
      "id": "string",
      "name": "string",
      "strategy": "string",
      "displayName": "string"
    }
  ],
  "displayName": "string",
  "loginDomain": "string"
}
Schema
Name Type Attributes Description Extensions
clients nullable — —
connections nullable — —
created string (date-time) nullable — —
createdBy string nullable — —
displayName string nullable —
maxLength: 200
 —
fqdn string nullable —
maxLength: 200
 —
id integer (int32) nullable — —
isActive boolean nullable — —
loginDomain string nullable —
maxLength: 200
 —
modified string (date-time) nullable — —
modifiedBy string nullable — —
name string nullable —
maxLength: 50
 —
roles nullable — —
Example 
{
  "id": 0,
  "fqdn": "string",
  "name": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "clients": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "mobile": {
        "ios": null,
        "android": null
      },
      "owners": [
        "string"
      ],
      "secret": "string",
      "logoUrl": "string",
      "grantTypes": [
        "string"
      ],
      "productName": "string",
      "callbackUrls": [
        "string"
      ],
      "client_upn_key": "string",
      "applicationName": "string",
      "manuallyCreated": false,
      "clientAuthMethod": "string",
      "allowedLogoutUrls": [
        "string"
      ],
      "allowedWebOrigins": [
        "string"
      ],
      "idTokenExpiration": 0,
      "allowedCorsOrigins": [
        "string"
      ],
      "refreshTokenReuseInterval": 0,
      "refreshTokenAbsoluteLifetime": 0,
      "isRefreshTokenRotationEnabled": false,
      "allowCrossOriginAuthentication": false,
      "refreshTokenInactivityLifetime": 0,
      "isRefreshTokenAbsoluteExpirationEnabled": false,
      "isRefreshTokenInactivityLifetimeEnabled": false
    }
  ],
  "created": "string",
  "isActive": false,
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "connections": [
    {
      "id": "string",
      "name": "string",
      "strategy": "string",
      "displayName": "string"
    }
  ],
  "displayName": "string",
  "loginDomain": "string"
}
Schema
Name Type Attributes Description Extensions
clients nullable — —
connections nullable — —
created string (date-time) nullable — —
createdBy string nullable — —
displayName string nullable —
maxLength: 200
 —
fqdn string nullable —
maxLength: 200
 —
id integer (int32) nullable — —
isActive boolean nullable — —
loginDomain string nullable —
maxLength: 200
 —
modified string (date-time) nullable — —
modifiedBy string nullable — —
name string nullable —
maxLength: 50
 —
roles nullable — —
Example 
{
  "id": 0,
  "fqdn": "string",
  "name": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "clients": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "mobile": {
        "ios": null,
        "android": null
      },
      "owners": [
        "string"
      ],
      "secret": "string",
      "logoUrl": "string",
      "grantTypes": [
        "string"
      ],
      "productName": "string",
      "callbackUrls": [
        "string"
      ],
      "client_upn_key": "string",
      "applicationName": "string",
      "manuallyCreated": false,
      "clientAuthMethod": "string",
      "allowedLogoutUrls": [
        "string"
      ],
      "allowedWebOrigins": [
        "string"
      ],
      "idTokenExpiration": 0,
      "allowedCorsOrigins": [
        "string"
      ],
      "refreshTokenReuseInterval": 0,
      "refreshTokenAbsoluteLifetime": 0,
      "isRefreshTokenRotationEnabled": false,
      "allowCrossOriginAuthentication": false,
      "refreshTokenInactivityLifetime": 0,
      "isRefreshTokenAbsoluteExpirationEnabled": false,
      "isRefreshTokenInactivityLifetimeEnabled": false
    }
  ],
  "created": "string",
  "isActive": false,
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "connections": [
    {
      "id": "string",
      "name": "string",
      "strategy": "string",
      "displayName": "string"
    }
  ],
  "displayName": "string",
  "loginDomain": "string"
}
Schema
Name Type Attributes Description Extensions
clients nullable — —
connections nullable — —
created string (date-time) nullable — —
createdBy string nullable — —
displayName string nullable —
maxLength: 200
 —
fqdn string nullable —
maxLength: 200
 —
id integer (int32) nullable — —
isActive boolean nullable — —
loginDomain string nullable —
maxLength: 200
 —
modified string (date-time) nullable — —
modifiedBy string nullable — —
name string nullable —
maxLength: 50
 —
roles nullable — —
Example 
{
  "id": 0,
  "fqdn": "string",
  "name": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "clients": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "mobile": {
        "ios": null,
        "android": null
      },
      "owners": [
        "string"
      ],
      "secret": "string",
      "logoUrl": "string",
      "grantTypes": [
        "string"
      ],
      "productName": "string",
      "callbackUrls": [
        "string"
      ],
      "client_upn_key": "string",
      "applicationName": "string",
      "manuallyCreated": false,
      "clientAuthMethod": "string",
      "allowedLogoutUrls": [
        "string"
      ],
      "allowedWebOrigins": [
        "string"
      ],
      "idTokenExpiration": 0,
      "allowedCorsOrigins": [
        "string"
      ],
      "refreshTokenReuseInterval": 0,
      "refreshTokenAbsoluteLifetime": 0,
      "isRefreshTokenRotationEnabled": false,
      "allowCrossOriginAuthentication": false,
      "refreshTokenInactivityLifetime": 0,
      "isRefreshTokenAbsoluteExpirationEnabled": false,
      "isRefreshTokenInactivityLifetimeEnabled": false
    }
  ],
  "created": "string",
  "isActive": false,
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "connections": [
    {
      "id": "string",
      "name": "string",
      "strategy": "string",
      "displayName": "string"
    }
  ],
  "displayName": "string",
  "loginDomain": "string"
}
Schema
Name Type Attributes Description Extensions
clients nullable — —
connections nullable — —
created string (date-time) nullable — —
createdBy string nullable — —
displayName string nullable —
maxLength: 200
 —
fqdn string nullable —
maxLength: 200
 —
id integer (int32) nullable — —
isActive boolean nullable — —
loginDomain string nullable —
maxLength: 200
 —
modified string (date-time) nullable — —
modifiedBy string nullable — —
name string nullable —
maxLength: 50
 —
roles nullable — —
Example 
{
  "id": 0,
  "fqdn": "string",
  "name": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "clients": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "mobile": {
        "ios": null,
        "android": null
      },
      "owners": [
        "string"
      ],
      "secret": "string",
      "logoUrl": "string",
      "grantTypes": [
        "string"
      ],
      "productName": "string",
      "callbackUrls": [
        "string"
      ],
      "client_upn_key": "string",
      "applicationName": "string",
      "manuallyCreated": false,
      "clientAuthMethod": "string",
      "allowedLogoutUrls": [
        "string"
      ],
      "allowedWebOrigins": [
        "string"
      ],
      "idTokenExpiration": 0,
      "allowedCorsOrigins": [
        "string"
      ],
      "refreshTokenReuseInterval": 0,
      "refreshTokenAbsoluteLifetime": 0,
      "isRefreshTokenRotationEnabled": false,
      "allowCrossOriginAuthentication": false,
      "refreshTokenInactivityLifetime": 0,
      "isRefreshTokenAbsoluteExpirationEnabled": false,
      "isRefreshTokenInactivityLifetimeEnabled": false
    }
  ],
  "created": "string",
  "isActive": false,
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "connections": [
    {
      "id": "string",
      "name": "string",
      "strategy": "string",
      "displayName": "string"
    }
  ],
  "displayName": "string",
  "loginDomain": "string"
}
Schema
Name Type Attributes Description Extensions
clients nullable — —
connections nullable — —
created string (date-time) nullable — —
createdBy string nullable — —
displayName string nullable —
maxLength: 200
 —
fqdn string nullable —
maxLength: 200
 —
id integer (int32) nullable — —
isActive boolean nullable — —
loginDomain string nullable —
maxLength: 200
 —
modified string (date-time) nullable — —
modifiedBy string nullable — —
name string nullable —
maxLength: 50
 —
roles nullable — —
Example 
{
  "id": 0,
  "fqdn": "string",
  "name": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "clients": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "mobile": {
        "ios": null,
        "android": null
      },
      "owners": [
        "string"
      ],
      "secret": "string",
      "logoUrl": "string",
      "grantTypes": [
        "string"
      ],
      "productName": "string",
      "callbackUrls": [
        "string"
      ],
      "client_upn_key": "string",
      "applicationName": "string",
      "manuallyCreated": false,
      "clientAuthMethod": "string",
      "allowedLogoutUrls": [
        "string"
      ],
      "allowedWebOrigins": [
        "string"
      ],
      "idTokenExpiration": 0,
      "allowedCorsOrigins": [
        "string"
      ],
      "refreshTokenReuseInterval": 0,
      "refreshTokenAbsoluteLifetime": 0,
      "isRefreshTokenRotationEnabled": false,
      "allowCrossOriginAuthentication": false,
      "refreshTokenInactivityLifetime": 0,
      "isRefreshTokenAbsoluteExpirationEnabled": false,
      "isRefreshTokenInactivityLifetimeEnabled": false
    }
  ],
  "created": "string",
  "isActive": false,
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "connections": [
    {
      "id": "string",
      "name": "string",
      "strategy": "string",
      "displayName": "string"
    }
  ],
  "displayName": "string",
  "loginDomain": "string"
}
Schema
Name Type Attributes Description Extensions
clients nullable — —
connections nullable — —
created string (date-time) nullable — —
createdBy string nullable — —
displayName string nullable —
maxLength: 200
 —
fqdn string nullable —
maxLength: 200
 —
id integer (int32) nullable — —
isActive boolean nullable — —
loginDomain string nullable —
maxLength: 200
 —
modified string (date-time) nullable — —
modifiedBy string nullable — —
name string nullable —
maxLength: 50
 —
roles nullable — —
Example 
{
  "id": 0,
  "fqdn": "string",
  "name": "string",
  "roles": [
    {
      "id": "string",
      "name": "string",
      "expires": "string",
      "description": "string"
    }
  ],
  "clients": [
    {
      "id": "string",
      "name": "string",
      "type": "string",
      "mobile": {
        "ios": null,
        "android": null
      },
      "owners": [
        "string"
      ],
      "secret": "string",
      "logoUrl": "string",
      "grantTypes": [
        "string"
      ],
      "productName": "string",
      "callbackUrls": [
        "string"
      ],
      "client_upn_key": "string",
      "applicationName": "string",
      "manuallyCreated": false,
      "clientAuthMethod": "string",
      "allowedLogoutUrls": [
        "string"
      ],
      "allowedWebOrigins": [
        "string"
      ],
      "idTokenExpiration": 0,
      "allowedCorsOrigins": [
        "string"
      ],
      "refreshTokenReuseInterval": 0,
      "refreshTokenAbsoluteLifetime": 0,
      "isRefreshTokenRotationEnabled": false,
      "allowCrossOriginAuthentication": false,
      "refreshTokenInactivityLifetime": 0,
      "isRefreshTokenAbsoluteExpirationEnabled": false,
      "isRefreshTokenInactivityLifetimeEnabled": false
    }
  ],
  "created": "string",
  "isActive": false,
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "connections": [
    {
      "id": "string",
      "name": "string",
      "strategy": "string",
      "displayName": "string"
    }
  ],
  "displayName": "string",
  "loginDomain": "string"
}
Schema
Name Type Attributes Description Extensions
clients nullable — —
connections nullable — —
created string (date-time) nullable — —
createdBy string nullable — —
displayName string nullable —
maxLength: 200
 —
fqdn string nullable —
maxLength: 200
 —
id integer (int32) nullable — —
isActive boolean nullable — —
loginDomain string nullable —
maxLength: 200
 —
modified string (date-time) nullable — —
modifiedBy string nullable — —
name string nullable —
maxLength: 50
 —
roles nullable — —
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

Try it