Management Portal Users

You can use REST API calls to obtain information about management portal users, to create or edit management portal users, and to delete management portal users.

Users who are provided with the management portal access secret are permitted to access the management portal API and the Cloudpath management portal. They must have a unique email which will allow limited auditing. For information about configuring management portals and their users, refer to the Cloudpath ES Property Management Configuration Guide.

The following table lists the properties that can be used in the body of a management portal user-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: User

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
guid String No both No* The unique identifier for this User. * Does not need to be provided on a POST but needs to be provided in all other cases, and will always be returned.
name String Yes both No The display name for this Users,
description String Yes both Yes A description of the user.
email String No Neither Yes The unique email for this user. It must be unique per management portal.

links

 Link No No Yes self, parent (management portal)

Management Portal User 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.

Management Portal User URIs and Actions

URI Action Description Return Codes
/mgmtPortals/{portal_guid}/users GET Returns the list of users that have been assigned to the specified management portal in the Cloudpath system.

401 - Unauthorized

200 - OK

POST Creates a user for the specified management portal.

401 - Unauthorized

201 - Created

/mgmtPortals/{portal_guid}/users {guid} GET Returns information about the specified user for the specified management portal.

404 - Not Found

401 - Unauthorized

200 - OK

DELETE Deletes the specified user from the list of permitted user for this management portal.

401 - Unauthorized

204 - No content

200 - OK

PUT Updates details about the specified user. A "409 - Conflict" message is returned if the email requested already exists in the list of users that have been assigned to this management portal.

409 - Conflict

404 - Not Found

401 - Unauthorized

200 - OK

Example of Using GET for Management Portal Users

This example demonstrates how to obtain a listing of all users that have been assigned to a specified management portal that has already been created in the Cloudpath UI.

URI:

This example uses the following URI: 

 https://Jeff245.cloudpath.net/admin/publicApi/mgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/users

where:

  • https://Jeff245.cloudpath.net/admin/publicApi is the root URI of the Cloudpath system being used (must include https, as shown).
  • MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503 is the GUID of the management portal.

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 eyJhbGciOiJIUzUxMiJ9.eyJhY2NvdW50UGsiOiIxIiwicm9sZVBrIjoiMjAwMDAiLCJhdWQiOiJSRVNUX0FQSSIsInN1YiI6IjEiLCJpc3MiOiJueEo5REV6aG1XUGJlSVZGaGR4Wm44cnh6aFhlR1AycmpOVHJxYndqSnhRPSIsImlhdCI6MTYyODg5MTkwMiwiZXhwIjoxNjI4ODkyMjAyfQ.yPA5OcUsfvkWtD298k-jvl-gCIE6fYEQ_dfl5mSAVYd5-iGsFEHwa_GTGOf4ahuKcPHVhhQCWOpoiUjL5uHEwg

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 all users who have been assigned to the management portal that you specified in the GET request, as shown in the following example. 

{
    "page": {
        "page": 1,
        "pageSize": 2,
        "totalCount": 2
    },
    "contents": [
        {
            "guid": "MduPortalAccessUser-ae875acd-005e-4112-a320-9d19be692121",
            "name": "Jeff",
            "description": "Backup property manager with full permissions\t",
            "email": "jeff@commscope.com",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/mgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/users/MduPortalAccessUser-ae875acd-005e-4112-a320-9d19be692121",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "mgmtPortal",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/mgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "MduPortalAccessUser-b1902748-aeb7-44f1-8aee-5cfec0287ce6",
            "name": "J. Smith",
            "description": "Property Manager for Lake View Apartments\t",
            "email": "js@lapts.com",
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/mgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/users/MduPortalAccessUser-b1902748-aeb7-44f1-8aee-5cfec0287ce6",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "mgmtPortal",
                    "href": "https://jeff245.cloudpath.net/admin/publicApi/mgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Parent topic: Management Portal APIs