Fetching a Tenant

To fetch a tenant, you must send a GET request to the following endpoint in the API:

https://api.platform.illow.io/open-api/v1/company/tenants/{tenantId}

info

Don't forget to include your Access Key in the X-API-Key header of all your requests.

Response Body

Format: JSON

Property	Type	Required?	Description
tenantId	string	Yes	The tenant's ID.
loginUrl	string	Yes	The URL to redirect the user to access the platform.
tenantName	string	Yes	The tenant's name for administration purposes. This will not be shown to your users.
sso	SSO Object	Yes	The SSO configuration for the tenant's users.

Examples

{
  "tenantId": "8374978f-51d8-421c-8f6e-da3734db7226",
  "loginUrl": "https://platform.illow.io/#/8374978f-51d8-421c-8f6e-da3734db7226/sign-in",
  "tenantName": "Big Telco, Inc.",
  "sso": {
    "saml": {
      "claims": {
        "mail": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress",
        "name": "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name",
      },
      "metadataUrl": "https://bigtelco.com/samlp/metadata?connection=illow",
    }
  }
}