Skip to main content

AccessControl

/api/AccessControl/AccessControlEntry

Get

Summary:

Returns all the accessControlEntrys according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The accessControlEntry list.List of AccessControlEntry

Post

Summary:

Creates a accessControlEntry.

Parameters:
NameDescriptionRequiredTypeReference
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the accessControlEntry creation.AccessControlEntryCreatedResult

/api/AccessControl/AccessControlEntry/{id}

Get

Summary:

Returns a accessControlEntry corresponding to the provided identifier and its information according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the accessControlEntry.True
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The accessControlEntry.AccessControlEntry

Put

Summary:

Updates a accessControlEntry.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the accessControlEntry to update.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the accessControlEntry update.AccessControlEntryUpdatedResult

Delete

Summary:

Deletes a accessControlEntry.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the accessControlEntry to delete.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the accessControlEntry delete.AccessControlEntryDeletedResult

/api/AccessControl/AccessControlFilter

Get

Summary:

Returns all the accessControlFilters according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The accessControlFilter list.List of AccessControlFilter

Post

Summary:

Creates a accessControlFilter.

Parameters:
NameDescriptionRequiredTypeReference
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the accessControlFilter creation.AccessControlFilterCreatedResult

/api/AccessControl/AccessControlFilter/{id}

Get

Summary:

Returns a accessControlFilter corresponding to the provided identifier and its information according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the accessControlFilter.True
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The accessControlFilter.AccessControlFilter

Put

Summary:

Updates a accessControlFilter.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the accessControlFilter to update.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the accessControlFilter update.AccessControlFilterUpdatedResult

Delete

Summary:

Deletes a accessControlFilter.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the accessControlFilter to delete.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the accessControlFilter delete.AccessControlFilterDeletedResult

/api/AccessControl/AccessControlPermission

Get

Summary:

Returns all the accessControlPermissions according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The accessControlPermission list.List of AccessControlPermission

/api/AccessControl/AccessControlPermission/{id}

Get

Summary:

Returns a accessControlPermission corresponding to the provided identifier and its information according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the accessControlPermission.True
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The accessControlPermission.AccessControlPermission

/api/AccessControl/AccessControlRule

Get

Summary:

Returns all the accessControlRules according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The accessControlRule list.List of AccessControlRule

Post

Summary:

Creates a accessControlRule.

Parameters:
NameDescriptionRequiredTypeReference
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the accessControlRule creation.AccessControlRuleCreatedResult

/api/AccessControl/AccessControlRule/{id}

Get

Summary:

Returns a accessControlRule corresponding to the provided identifier and its information according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the accessControlRule.True
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The accessControlRule.AccessControlRule

Put

Summary:

Updates a accessControlRule.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the accessControlRule to update.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the accessControlRule update.AccessControlRuleUpdatedResult

Delete

Summary:

Deletes a accessControlRule.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the accessControlRule to delete.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the accessControlRule delete.AccessControlRuleDeletedResult

/api/AccessControl/AssignedProfile

Get

Summary:

Returns all the assigned profiles according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
squeryQuery compliant to the API query grammar.False
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The assigned profile list.List of AssignedProfile

Post

Summary:

Creates an assigned profile.

Parameters:
NameDescriptionRequiredTypeReference
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the assigned profile creation.AssignedProfileCreatedResult

/api/AccessControl/AssignedProfile/{id}

Get

Summary:

Returns an assigned profile corresponding to the provided identifier and its information according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the assigned profile.True
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The assigned profile.AssignedProfile

Put

Summary:

Updates an assigned profile with support for both full and incremental profile context updates.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the assigned profile to update.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the assigned profile update.AssignedProfileUpdatedResult

Delete

Summary:

Deletes an assigned profile.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the assigned profile to delete.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the assigned profile delete.AssignedProfileDeletedResult

/api/AccessControl/OpenIdClient

Get

Summary:

Returns all the openId clients according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The clients list.List of OpenIdClient

Post

Summary:

Creates an openId client.

Parameters:
NameDescriptionRequiredTypeReference
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the openId client creation.OpenIdClientCreatedResult

/api/AccessControl/OpenIdClient/{id}

Get

Summary:

Returns an openId client corresponding to the provided identifier and its information according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the openId client.True
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The open id client.OpenIdClient

Put

Summary:

Updates an openId client.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the openId client to update.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the openId client update.OpenIdClientUpdatedResult

Delete

Summary:

Deletes an openId client.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the openId client to delete.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the openId client delete.OpenIdClientDeletedResult

/api/AccessControl/Profile

Get

Summary:

Returns all the profiles according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The profile list.List of Profile

Post

Summary:

Creates a profile.

Parameters:
NameDescriptionRequiredTypeReference
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the profile creation.ProfileCreatedResult

/api/AccessControl/Profile/{id}

Get

Summary:

Returns a profile corresponding to the provided identifier and its information according to the provided query.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the profile.True
squeryQuery compliant to the API query grammar.False
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The profile.Profile

Put

Summary:

Updates a profile.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the profile to update.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the profile update.ProfileUpdatedResult

Delete

Summary:

Deletes a profile.

Parameters:
NameDescriptionRequiredTypeReference
idIdentifier of the profile to delete.True
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200The result of the profile delete.ProfileDeletedResult

/api/AccessControl/ProfileRuleContext

Get

Parameters:
NameDescriptionRequiredTypeReference
squeryFalse
PathRepresents the permission path.False
QueryRootEntityTypeDefines the query root entity type.False
QueryBindingDefines the query binding.False
ApplyPostConditionIf true, use PostCondition access control rules.False
AllowedAllJoinQueryFalse
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:
CodeDescriptionReference
200OKList of ProfileRuleContext