| Service | API | Method | Data Models | Workflow |
|---|
| multitenancy | /tenants | GET | Tenant | N/A |
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
| type | Query | NO | String | "enum": ["product", "client"] | Tenant Type |
Output
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block |
|---|
| language | js |
|---|
| title | Valid Response Sample |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
result: true,
data:
[
{
_id: '5d7fa308d5ee5a3d2ca439da',
oauth: {
secret: "%secret%",
redirectURI: "http://domain.com",
grants: [
"password",
"refresh_token"
],
disabled: 0,
type: 2.0,
loginMode: "urac"
},
code: 'test',
name: 'Test Tenant',
description: 'this is a description for test tenant',
applications: [Array]
}
]
} |
Invalid Response
| Code Block |
|---|
| language | js |
|---|
| title | Error Response Sample |
|---|
| linenumbers | true |
|---|
| collapse | true |
|---|
|
{
"result":false,
"errors":{
"codes":[436],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
} |
Response schema
Follow this link to check out the response JSON Schema
SOAJS Error Codes
| |
|---|
| 400 | Business logic required data are missing |
| 460 | Unable to find tenant |
| 602 | Model error: + %model_error% |