• Document Up to Date

Get All Tenants

Returns a list with all the tenants.

Resource Information

This service uses the tomcat application on port 8080 by default. To see a list of default ports click here

The context for this API is /crafter-profile, please prefix the API URLs with this context.

HTTP Verb
GET
URL
/api/1/tenant/all
Response Formats
JSON

Parameters

Name
Type
Required
Description
accessTokenId

String


The access token ID of the application
making the call
name
String
The tenant’s name

Example

Request

GET .../api/1/tenant/all?accessTokenId=e8f5170c-877b-416f-b70f-4b09772f8e2d

Response

Status 200 OK

  1[
  2  {
  3    "name": "default",
  4    "verifyNewProfiles": false,
  5    "availableRoles": [
  6      "SOCIAL_SUPERADMIN",
  7      "PROFILE_ADMIN",
  8      "PROFILE_SUPERADMIN",
  9      "PROFILE_TENANT_ADMIN"
 10    ],
 11    "ssoEnabled": false,
 12    "attributeDefinitions": [
 13      {
 14        "permissions": [
 15          {
 16            "allowedActions": [
 17              "*"
 18            ],
 19            "application": "*"
 20          }
 21        ],
 22        "name": "firstName",
 23        "metadata": {
 24          "label": "First Name",
 25          "type": "TEXT",
 26          "displayOrder": 0.0
 27        },
 28        "defaultValue": null
 29      },
 30      {
 31        "permissions": [
 32          {
 33            "allowedActions": [
 34              "*"
 35            ],
 36            "application": "*"
 37          }
 38        ],
 39        "name": "lastName",
 40        "metadata": {
 41          "label": "Last Name",
 42          "type": "TEXT",
 43          "displayOrder": 1.0
 44        },
 45        "defaultValue": null
 46      },
 47      {
 48        "permissions": [
 49          {
 50            "allowedActions": [
 51              "*"
 52            ],
 53            "application": "*"
 54          }
 55        ],
 56        "name": "displayName",
 57        "metadata": {
 58          "label": "Display Name",
 59          "type": "TEXT",
 60          "displayOrder": 2.0
 61        },
 62        "defaultValue": null
 63      },
 64      {
 65        "permissions": [
 66          {
 67            "allowedActions": [
 68              "*"
 69            ],
 70            "application": "*"
 71          }
 72        ],
 73        "name": "avatarLink",
 74        "metadata": {
 75          "label": "Avatar Link",
 76          "type": "TEXT",
 77          "displayOrder": 3.0
 78        },
 79        "defaultValue": null
 80      },
 81      {
 82        "permissions": [
 83          {
 84            "allowedActions": [
 85              "*"
 86            ],
 87            "application": "*"
 88          }
 89        ],
 90        "name": "socialContexts",
 91        "metadata": {
 92          "label": "Social Contexts",
 93          "type": "COMPLEX",
 94          "displayOrder": 4.0
 95        },
 96        "defaultValue": null
 97      },
 98      {
 99        "permissions": [
100          {
101            "allowedActions": [
102              "*"
103            ],
104            "application": "*"
105          }
106        ],
107        "name": "connections",
108        "metadata": {
109          "label": "Connections",
110          "type": "COMPLEX",
111          "displayOrder": 5.0
112        },
113        "defaultValue": null
114      }
115    ],
116    "id": "5926f6c524d9aaad9804a401"
117  },
118  {
119    "name": "sample-tenant",
120    "verifyNewProfiles": false,
121    "availableRoles": [
122      "APP_ADMIN",
123      "APP_USER"
124    ],
125    "ssoEnabled": false,
126    "attributeDefinitions": [
127      {
128        "permissions": [
129          {
130            "allowedActions": [
131              "*"
132            ],
133            "application": "*"
134          }
135        ],
136        "name": "firstName",
137        "metadata": {
138          "label": "First Name",
139          "type": "TEXT",
140          "displayOrder": 0.0
141        },
142        "defaultValue": null
143      },
144      {
145        "permissions": [
146          {
147            "allowedActions": [
148              "*"
149            ],
150            "application": "*"
151          }
152        ],
153        "name": "lastName",
154        "metadata": {
155          "label": "Last Name",
156          "type": "TEXT",
157          "displayOrder": 1.0
158        },
159        "defaultValue": null
160      },
161      {
162        "permissions": [
163          {
164            "allowedActions": [
165              "*"
166            ],
167            "application": "*"
168          }
169        ],
170        "name": "avatarLink",
171        "metadata": {
172          "label": "Avatar Link",
173          "type": "TEXT",
174          "displayOrder": 3.0
175        },
176        "defaultValue": null
177      }
178    ],
179    "id": "5926f6d9d4c650e226b03b61"
180  }
181]

Responses

Status
Location
Response Body
200

See example above.
500

{ "message" : "Internal server error" }