[Index]

Model: data/AccessProfile

Access Profile Permissions and Operations

Administrators above Provider level can maintain Access Profiles as a part of Role Management. In particular, a profile assigned to a role can provide a general set of permissions and well as Type-specific operations which are associated with specific models.

For Type-specific operations, wild cards may be used in model references, for example data/*.

Note

The default access profiles show typical configurations, for example an Operator-type profile at a hierarchy would only require Read type-specific permissions, while the administrator profile at the same hierarchy would have Create, Update and Delete permissions for the same type.

The lists below provide details on the types of settings.

Access profiles define model types that a user is permitted to access. Access profiles are assigned to users via Roles

Model Details

Title Description Details
Name * The name that is given to the Access Profile.
  • Field Name: name
  • Type: String
Description A description for the Access Profile.
  • Field Name: description
  • Type: String
Full Access Enabling this flag, grants the user full system access.
  • Field Name: full_access
  • Type: Boolean
Miscellaneous Permissions The list of miscellaneous operations permitted by this Access Profile.
  • Field Name: miscellaneous_permissions.[n]
  • Type: Array
Type Specific Permissions The list of types that are permitted by this Access Profile.
  • Field Name: type_specific_permissions.[n]
  • Type: Array
Permitted Type * The type that is permitted by this Access Profile. This field supports the use of the * wildcard.
  • Field Name: type_specific_permissions.[n].type
  • Type: String
  • Format: uri
Permitted Operations The operations that are permitted by this Access Profile for the given type.
  • Field Name: operations.[n]
  • Type: Array
API reference for data/AccessProfile