Guest Profiles version 6.5.16

https://{safeconnect}/apis

The Guest Profile API in version 6.5.16 provides access to retrieve a list of all guest profiles and the ability to enable/disable guest profiles by ID. This functionality allows guest profiles to be temporarily disabled and enabled again later. For example, a SafeConnect admin might disable guest profiles over a weekend and then enable them again on weekdays. Note that as of version 6.5.16, there is no means to disable all guest profiles with a single call. To disable multiple guest profiles, the SafeConnect admin needs to make separate calls for each profile.

  • safeconnect: required(string)

    The URL or IP address of your SafeConnect manager, or the single SafeConnect appliance in a standalone configuration.

/guestProfile

get

get

Get a list of all guest profiles.

put

put

Enable or disable a guest profile by ID.

Enable or disable a guest profile by ID.

URI Parameters

  • id: required(string)

Query Parameters

  • enabled: required(boolean)

    Enabled state of the guest profile

HTTP status code 200

Updated GuestProfile

Body

Media type: application/json

Type: object

Properties
  • id: required(number)
  • label: required(string)
  • displayName: required(string)
  • description: required(string)
  • enabled: required(number)
  • maxRenewals: required(number)
  • startAtActivation: required(number)
  • starttime: required(datetime)
  • expirationOption: required(string)
  • endtime: required(datetime)
  • initialDurationMins: required(number)
  • renewalDurationMins: required(number)
  • revokeOnExpiration: required(string)
  • validationLevel: required(string)
  • properties
  • notifyOption: required(string)
  • prohibitedDomains: required(string)
  • preventAbuse: required(number)
  • metadata: required(object)
    • id: required(number)
    • validatorsEmailList: required(string)
    • approvalEmailTemplate: required(string)
    • adminEmailTemplate: required(string)
    • guestEmailTemplate: required(string)
    • smsTemplate: required(string)
    • senderEmail: required(string)
    • lockoutDurationDays: required(number)
    • createDate: required(datetime)
    • createUser: required(datetime)
    • lstUpdDate: required(datetime)
    • lstUpdUser: required(datetime)
  • primaryRoles: required(object)
    • id: required(number)
    • label: required(string)
    • description: required(string)
    • endUserDisplay: required(string)
    • displayType: required(number)
    • priority: required(number)
    • version: required(number)
  • createDate: required(datetime)
  • createUser: required(datetime)
  • lstUpdDate: required(datetime)
  • lstUpdUser: required(datetime)

HTTP status code 400

If the enabled request parameter isn't a valid boolean

Body

Media type: application/json

Type: string

HTTP status code 404

If the id URI parameter isn't a valid guest profile ID

Body

Media type: application/json

Type: string

HTTP status code 500

An unexpected server error occurred