API Reference Models

Definitions

ClientApiModel

Name	Schema
createdBy optional	string
createdDateTimeUtc required	string
id optional	string
identifier optional	string
modifiedBy optional	string
modifiedDateTimeUtc optional	string
name optional	string
topLevelSecurableItem optional	SecurableItemApiModel

GranularPermissionApiModel

Name	Schema
createdBy optional	string
createdDateTimeUtc required	string
id optional	string
identifier optional	string
modifiedBy optional	string
modifiedDateTimeUtc optional	string
permissions optional	< PermissionApiModel > array
target optional	string

GroupRoleApiModel

Name	Schema
groupName optional	string
groupSource optional	string
id optional	string
identifier optional	string
roles optional	< RoleApiModel > array

Guid

Type : object

NullableOfDateTime

Name	Schema
hasValue required	boolean
value required	string

NullableOfGuid

Name	Schema
hasValue required	boolean
value required	Guid

PermissionApiModel

Name	Schema
createdBy optional	string
createdDateTimeUtc required	string
grain optional	string
id optional	NullableOfGuid
identifier optional	string
modifiedBy optional	string
modifiedDateTimeUtc optional	string
name optional	string
securableItem optional	string

RoleApiModel

Name	Schema
childRoles optional	< Guid > array
createdBy optional	string
createdDateTimeUtc required	string
deniedPermissions optional	< PermissionApiModel > array
grain optional	string
id optional	NullableOfGuid
identifier optional	string
modifiedBy optional	string
modifiedDateTimeUtc optional	string
name optional	string
parentRole optional	NullableOfGuid
permissions optional	< PermissionApiModel > array
securableItem optional	string

SecurableItemApiModel

Name	Schema
createdBy optional	string
createdDateTimeUtc required	string
id optional	NullableOfGuid
identifier optional	string
modifiedBy optional	string
modifiedDateTimeUtc optional	string
name optional	string
securableItems optional	< SecurableItemApiModel > array

UserPermissionsApiModel

Name	Schema
permissions optional	< string > array
requestedGrain optional	string
requestedSecurableItem optional	string