Tenant Portal Properties

You can use tenant portal API calls to obtain information about existing properties.

The following table lists the properties that can be used in the body of a properties-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >).)

Resource: Properties

Property Name	Type	Editable	Sort/Filter	Optional in Request/Response Body?	Description
guid	String	No	orderBy, like	Optional on create only, but not on any subsequent uses.	The unique identifier for this property.
name	String	Yes	orderBy, like	No	The display name for this property, must be unique
address	String	Yes	orderBy, like	Yes	The address for this property.
description	String	Yes	orderBy, like	Yes	A description for this property.
enforceMaxUnits	Boolean	Yes	orderBy, like	Yes<false>	Indicates if a value configured for "max units" will be enforced when adding a unit to the property.
maxUnits	int	Yes	orderBy, like	No<0>	The maximum number of units permitted for this property.
allowSeparateGuestSecret	Boolean	Yes	orderBy, like	Yes<true>	Indicates whether units asigned to this property will have a separate secret for a separate guest network. This value may not be changed once the first unit is assigned to this property.
ssids	Array<String>	No	No	Yes	This is the list of ssids that are available to this property by means of the DPSK pool that this property is assigned to.
managementName	String	Yes	orderBy, like	Yes	Name that will be assigned in all email and SMS communications.
managementPhone	String	Yes	orderBy, like	Yes	Phone that will be assigned in all email and SMS communications.
managementEmail	String	Yes	orderBy, like	Yes	Email that will be assigned in all email and SMS communications
tenantPortalHelpText	String	Yes	Neither	Yes	Help text that will be provided to users of the tenant portal.
tenantPortalAnnouncements	String	Yes	Neither	Yes	Announcements that will be provided to users of the tenant portal.
links self, units, uiConfiguration	Link	Yes*	orderBy	Optional on create only, but not on any subsequent uses.	Self-referencing link, uiConfiguration link, and link to the list of units associated with this property.

Resource: UiConfiguration

Property Name	Type	Editable	Sort/Filter	Optional in Request/Response Body?	Description
tenantTitle	String	Yes	No	Yes	The title to use in the Tenant UI.
tenantSubtitle	String	Yes	No	Yes	The subtitle to use in the Tenant UI.
mainColor	String	Yes	No	Yes	The main color is used for the main header and any buttons or links. White text will be used on top of this color.
accentColor	String	Yes	No	Yes	The accent color is used for sub-headers and borders.
separatorColor	String	Yes	No	Yes	The separator color is used for lines in between rows of data.
textColor	String	Yes	No	Yes	The text color is the default text color used to display information throughout the portal.
logoFileName	String	NO	No	Yes	The name of the logo file, if one has been uploaded. This will be updated when the logo file is changed via the logo file link.
links					logoFile, self, and property

Resource: Access Resource

Property Name	Type	Editable	Sort/Filter	Optional in Request/Response Body?	Description
loginText	String	No	Neither	Yes	The login text string to use for this property. If not provided, the default text is used.
portalAllowed	boolean	Yes	Neither	No, default is true	Indicates if this property supports the Cloudpath tenant portal.

Properties URIs and Actions

The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.

Property URIs and Actions

URI	Action	Description	Return Codes
/properties/{guid}	GET	Returns details about the specified property.	404 - Not found 401 - Unauthorized 200 - OK
/properties/{guid}/uiConfiguration	GET	Returns the details of the tenant portal UI configuration, such as the color scheme being used and the name of a logo file if one is being used.	404 - Not found 401 - Unauthorized 200 - OK
/properties/{guid}/uiConfiguration/access	GET	An unauthenticated endpoint that returns the access resource detailed above. This indicates if the property has enabled the tenant portal and the login text to present to the tenant.	404 - Not found 200 - OK
/properties/{guid}/uiConfiguration/styles	GET	An unauthenticated endpoint that returns a css detailing the style settings for the tenant portal: mediaType= "text/css"	404 - Not found 200 - OK
/properties/{guid}/uiConfiguration/logoFile	GET	Returns the logo file as the actual image. The response will include the file type.	404 - Not found 401 - Unauthorized 200 - OK
/properties/{guid}/uiConfiguration/favicon	GET	An unauthenticated endpoint that returns an image to be used for the tenant portal favicon. The default favicon is returned if one of the following is true: an invalid API key is provided The provided property is not associated with the API key The user could not be authenticated. No custom favicon is set. No property matches the provided property GUID. The custom favicon for the property is returned if the user is authorized and a custom favicon has been set. A "401 - Unauthorized" message is returned instead of a favicon if the property exists but the tenant API is disabled.	401 - Unauthorized 200 - OK

Example of Using GET for Properties

This example demonstrates how to obtain information about a specific property.

URI:

This example uses the following URI:

 https://Jeff245.cloudpath.net/admin/rest/tenant/yRCjJObWR6ER/properties/Property-afaccdf8-5e39-41ce-9098-9747cc38aaa0

where:

https://Jeff245.cloudpath.net/admin/rest/tenant is the root URI of the Cloudpath system being used (must include https, as shown)

yRCjJObWR6ER is an example of an API key generated from the Configuration > API Keys section of the Cloudpath UI

Property-afaccdf8-5e39-41ce-9098-9747cc38aaa0 is the GUID of the specific property.

Request Headers:

The following table shows the required request headers for this URI example, with an example value of an active token that must be pasted into the Authorization header value:

Request Headers

Key	Value
Content-type	application/json
Authorization	eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJBcGFydG1lbnQgMSIsImFjY2Vzc1Rva2VuIjoiWkFZZGxMM0ciLCJwcm9wZXJ0eUd1aWQiOiJQcm9wZXJ0eS1hZmFjY2RmOC01ZTM5LTQxY2UtOTA5OC05NzQ3Y2MzOGFhYTAiLCJ1bml0R3VpZCI6IlVuaXQtZjU5ZjJjOTMtNjc4Ni00ZDhlLWFkYWQtMmU0NGQzM2RmMzk5IiwiYXBpS2V5IjoieVJDakpPYldSNkVSIiwiaWF0IjoxNjE0MTMwNjg2LCJleHAiOjE2MTQxMzA5ODZ9.ZO1NsBYwKDLCcHgQPKZI493oHoJakQtqzp5KgMEx0-o

Request Body:

None required.

Action:

Use the GET action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful. The response body provides information about the requested property.

{
    "guid": "Property-afaccdf8-5e39-41ce-9098-9747cc38aaa0",
    "name": "Building 1",
    "address": "",
    "description": "",
    "enforceMaxUnits": false,
    "maxUnits": 0,
    "allowSeparateGuestSecret": true,
    "ssids": [
        "SSID20",
        "SSID19"
    ],
    "managementName": "J. Smith",
    "managementPhone": "0005550100",
    "managementEmail": "js@smith.com",
    "tenantPortalHelpText": "",
    "tenantPortalAnnouncements": "Pavement work happening this Tuesday.",
    "links": [
        {
            "rel": "self",
            "href": "https://jeff245.cloudpath.net/admin/rest/tenant/yRCjJObWR6ER/properties/Property-afaccdf8-5e39-41ce-9098-9747cc38aaa0",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "uiConfiguration",
            "href": "https://jeff245.cloudpath.net/admin/rest/tenant/yRCjJObWR6ER/properties/Property-afaccdf8-5e39-41ce-9098-9747cc38aaa0/uiConfiguration",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        }
    ]
}

Cloudpath Enrollment System REST API User Guide, 5.9R4 800-73101-001 Rev A