ProfileApiData

The Profile definition object contains the definition for a user profile.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

profileId

The system ID of the profile. When adding a profile, the provided GUID will be used if supplied. Otherwise, the function will auto-create it.

 -

string

name

Profile's name or caption

Y

string

description

Profile's description

Y

string

permissions

Profile's permissions (using either numeric switches or an array of switches).

Y

ProfilePermissionHolder

tenantId

The profile's tenant (ID)

Y

string

*Required elements are only used for API parameters

Usages
  • /API2/access/addProfile
  • /API2/access/getAllProfiles
  • /API2/access/getAllProfilesByClientLicenseType
  • /API2/access/getAllProfilesByClientLicenseTypeByTenantId
  • /API2/access/getAllProfilesByTenantId