API Reference Models

Definitions

ClientApiModel

Name	Schema
createdBy optional	string
createdDateTimeUtc required	string
id 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

GroupIdentifierApiRequest

Name	Schema
groupName optional	string
identityProvider optional	string
tenantId optional	string

GroupPatchApiRequest

Name	Schema
description optional	string
displayName optional	string

GroupRoleApiModel

Name	Schema
children optional	< GroupRoleApiModel > array
description optional	string
displayName optional	string
groupName optional	string
groupSource optional	string
id optional	NullableOfGuid
identityProvider optional	string
parents optional	< GroupRoleApiModel > array
roles optional	< RoleApiModel > array
tenantId optional	string

GroupUserApiModel

Name	Schema
description optional	string
displayName optional	string
groupName optional	string
groupSource optional	string
id optional	NullableOfGuid
users optional	< UserApiModel > array

Guid

Type : object

InnerError

Name	Schema
code optional	string
innerError optional	InnerError

MemberSearchRequest

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

MemberSearchResponse

Name	Schema
displayName optional	string
entityType optional	string
firstName optional	string
groupName optional	string
identityProvider optional	string
lastLoginDateTimeUtc optional	string
lastName optional	string
middleName optional	string
roles optional	< RoleApiModel > array
subjectId optional	string
tenantId optional	string

NullableOfDateTime

Name	Schema
hasValue required	boolean
value required	string

NullableOfGuid

Name	Schema
hasValue required	boolean
value required	Guid

PermissionAction

Type : enum (Allow, Deny)

PermissionApiModel

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

PermissionRequestContext

Name	Schema
requestedGrain optional	string
requestedSecurableItem optional	string

PermissionRoleApiModel

Name	Schema
id optional	NullableOfGuid
name optional	string

ResolvedPermissionApiModel

Name	Schema
createdBy optional	string
createdDateTimeUtc required	string
grain optional	string
id optional	NullableOfGuid
modifiedBy optional	string
modifiedDateTimeUtc optional	string
name optional	string
permissionAction required	PermissionAction
roles optional	< PermissionRoleApiModel > array
securableItem optional	string

RoleApiModel

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

RoleIdentifierApiRequest

Name	Schema
roleId required	Guid

RolePatchApiRequest

Name	Schema
description optional	string
displayName optional	string

SecurableItemApiModel

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

UserApiModel

Name	Schema
groups optional	< string > array
identityProvider optional	string
identityProviderUserPrincipalName optional	string
roles optional	< RoleApiModel > array
subjectId optional	string

UserIdentifierApiRequest

Name	Schema
identityProvider optional	string
subjectId optional	string

UserPermissionsApiModel

Name	Schema
permissionRequestContexts optional	< PermissionRequestContext > array
permissions optional	< string > array