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
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The accessControlEntry list.

Post​

Summary:​

Creates a accessControlEntry.

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

/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
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The 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.

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.

/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
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The accessControlFilter list.

Post​

Summary:​

Creates a accessControlFilter.

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

/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
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The 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.

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.

/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
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The accessControlPermission list.

/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
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The 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
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The accessControlRule list.

Post​

Summary:​

Creates a accessControlRule.

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

/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
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The 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.

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.

/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
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The assigned profile list.

Post​

Summary:​

Creates an assigned profile.

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

/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
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The assigned profile.

Put​

Summary:​

Updates an assigned profile.

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

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.

/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
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The clients list.

Post​

Summary:​

Creates an openId client.

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

/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
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The open id client.

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.

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.

/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
PageSizePage size.False
ContinuationTokenContinuationToken returned by previous page request.False
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The profile list.

Post​

Summary:​

Creates a profile.

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

/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
api-versionThe requested API versionTrue
Responses:​
CodeDescriptionReference
200The 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.

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.