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

Error

Name	Schema
code optional	string
details optional	< Error > array
innererror optional	InnerError
message optional	string
target optional	string

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

GroupUserApiModel

Name	Schema
groupName optional	string
groupSource optional	string
id optional	string
identifier optional	string
users optional	< UserApiModel > array

Guid

Type : object

IdentitySearchRequest

Name	Schema
clientId optional	string
filter optional	string
pageNumber optional	integer
pageSize optional	integer
sortDirection optional	string
sortKey optional	string

IdentitySearchResponse

Name	Schema
entityType required	IdentitySearchResponseEntityType
firstName optional	string
groupName optional	string
identityProvider optional	string
lastLogin optional	string
lastName optional	string
middleName optional	string
name optional	string
roles optional	< string > array
subjectId optional	string

IdentitySearchResponseEntityType

Type : enum (User, Group)

InnerError

Name	Schema
code optional	string
innererror optional	InnerError

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

UserApiModel

Name	Schema
groups optional	< string > array
subjectId optional	string

UserPermissionsApiModel

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