Tenant Methods
When Data360 Analyze is configured to support multiple tenants, the client must identify which tenant it belongs to before authenticating. The Tenant Methods API returns a set of tenant methods that may be used to identify the tenant. The order of the methods in the response indicates the priority in which they should be tried.
Note that Data360 Analyze is most commonly configured to support a single tenant. In this case the tenant is always identified using the tenant locator object:!tenant:defaultTenant
.
Get Tenant Methods
A GET
request is used to retrieve the tenant methods.
Request parameters
None
Request fields
None
Response fields
Path | Type | Description |
---|---|---|
|
|
The name of the tenant method. |
|
|
The URI of the tenant method. |
|
|
HTTP Status Code. |
Example request
GET /api/v3/login/rest/tenant/methods HTTP/1.1
Host: localhost:8080
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 68
{"status":"OK","data":{"methods":[{"name":"automatic","uri":null}]}}
Resolve Tenant Automatically
Using the Automatic Tenant Resolver, Data360 Analyze will attempt to identify the tenant based on the system configuration.
A GET
request is used to resolve the tenant automatically.
Request parameters
None
Request fields
None
Response fields
Path | Type | Description |
---|---|---|
|
|
The tenant that the authenticating user belongs to. |
|
|
The URI to retrieve the authentication methods supported by the tenant. |
|
|
HTTP Status Code. |
Example request
GET /api/v3/login/rest/tenant/automatic HTTP/1.1
Host: localhost:8080
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 181
{"status":"OK","data":{"tenantLocator":"object:!tenant:defaultTenant","tenantAuthMethodsUri":"/api/v3/login/rest/authentication/methods?tenantLocator=object:!tenant:defaultTenant"}}