Package org.azd.security.accesscontrolentries

Class AccessControlEntriesRequestBuilder

java.lang.Object
org.azd.abstractions.BaseRequestBuilder
org.azd.security.accesscontrolentries.AccessControlEntriesRequestBuilder
public class AccessControlEntriesRequestBuilder extends BaseRequestBuilder
Provides functionality to work with Security Access control entries Api.

  • Constructor Details

    • AccessControlEntriesRequestBuilder

      public AccessControlEntriesRequestBuilder(String organizationUrl, AccessTokenCredential accessTokenCredential)
      Instantiates a new RequestBuilder instance and sets the default values.
      Parameters:
      organizationUrl - Represents organization location request url.
      accessTokenCredential - Access token credential object.

  • Method Details

    • removeAsync

      public CompletableFuture<Boolean> removeAsync(String securityNamespaceId, Consumer<AccessControlEntriesRequestBuilder.DeleteRequestConfiguration> requestConfiguration) throws AzDException
      Remove the specified ACEs from the ACL belonging to the specified token.
      Parameters:
      securityNamespaceId - Security namespace identifier.
      requestConfiguration - Represents the query parameters.
      Throws:
      AzDException - Default Api Exception handler.

    • setAsync

      public CompletableFuture<ACEs> setAsync(String securityNamespaceId, ACEs setAccessControlEntryRequest) throws AzDException
      Add or update ACEs in the ACL for the provided token. The request body contains the target token, a list of ACEs and a optional merge parameter. In the case of a collision (by identity descriptor) with an existing ACE in the ACL, the "merge" parameter determines the behavior. If set, the existing ACE has its allow and deny merged with the incoming ACE's allow and deny. If unset, the existing ACE is displaced.
      Parameters:
      securityNamespaceId - Security namespace identifier.
      setAccessControlEntryRequest - Request body to add or update the access control entries.
      Returns:
      Collection of access control entry ACEs
      Throws:
      AzDException - Default Api Exception handler.

    • remove

      public Boolean remove(String securityNamespaceId, Consumer<AccessControlEntriesRequestBuilder.DeleteRequestConfiguration> requestConfiguration) throws AzDException
      Remove the specified ACEs from the ACL belonging to the specified token.
      Parameters:
      securityNamespaceId - Security namespace identifier.
      requestConfiguration - Represents the query parameters.
      Throws:
      AzDException - Default Api Exception handler.

    • set

      public ACEs set(String securityNamespaceId, ACEs setAccessControlEntryRequest) throws AzDException
      Add or update ACEs in the ACL for the provided token. The request body contains the target token, a list of ACEs and a optional merge parameter. In the case of a collision (by identity descriptor) with an existing ACE in the ACL, the "merge" parameter determines the behavior. If set, the existing ACE has its allow and deny merged with the incoming ACE's allow and deny. If unset, the existing ACE is displaced.
      Parameters:
      securityNamespaceId - Security namespace identifier.
      setAccessControlEntryRequest - Request body to add or update the access control entries.
      Returns:
      Collection of access control entry ACEs
      Throws:
      AzDException - Default Api Exception handler.
      See Also: