Interface BatchIsAuthorizedWithTokenRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<BatchIsAuthorizedWithTokenRequest.Builder,BatchIsAuthorizedWithTokenRequest>, SdkBuilder<BatchIsAuthorizedWithTokenRequest.Builder,BatchIsAuthorizedWithTokenRequest>, SdkPojo, SdkRequest.Builder, VerifiedPermissionsRequest.Builder
Enclosing class:
BatchIsAuthorizedWithTokenRequest
@Mutable @NotThreadSafe public static interface BatchIsAuthorizedWithTokenRequest.Builder extends VerifiedPermissionsRequest.Builder, SdkPojo, CopyableBuilder<BatchIsAuthorizedWithTokenRequest.Builder,BatchIsAuthorizedWithTokenRequest>

  • Method Details

    • policyStoreId

      BatchIsAuthorizedWithTokenRequest.Builder policyStoreId(String policyStoreId)

      Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

      Parameters:
      policyStoreId - Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • identityToken

      BatchIsAuthorizedWithTokenRequest.Builder identityToken(String identityToken)

      Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

      Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

      Parameters:
      identityToken - Specifies an identity (ID) token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

      Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • accessToken

      BatchIsAuthorizedWithTokenRequest.Builder accessToken(String accessToken)

      Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

      Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

      Parameters:
      accessToken - Specifies an access token for the principal that you want to authorize in each request. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

      Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entities

      BatchIsAuthorizedWithTokenRequest.Builder entities(EntitiesDefinition entities)

      (Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

      You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

      • The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.

      • For action entities, you can include only their Identifier and EntityType.

      Parameters:
      entities - (Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

      You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

      • The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.

      • For action entities, you can include only their Identifier and EntityType.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entities

      default BatchIsAuthorizedWithTokenRequest.Builder entities(Consumer<EntitiesDefinition.Builder> entities)

      (Optional) Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies. These additional entities and their attributes can be referenced and checked by conditional elements in the policies in the specified policy store.

      You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

      • The BatchIsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.

      • For action entities, you can include only their Identifier and EntityType.

      This is a convenience method that creates an instance of the EntitiesDefinition.Builder avoiding the need to create one manually via EntitiesDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to entities(EntitiesDefinition).

      Parameters:
      entities - a consumer that will call methods on EntitiesDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • requests

      BatchIsAuthorizedWithTokenRequest.Builder requests(Collection<BatchIsAuthorizedWithTokenInputItem> requests)

      An array of up to 30 requests that you want Verified Permissions to evaluate.

      Parameters:
      requests - An array of up to 30 requests that you want Verified Permissions to evaluate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requests

      BatchIsAuthorizedWithTokenRequest.Builder requests(BatchIsAuthorizedWithTokenInputItem... requests)

      An array of up to 30 requests that you want Verified Permissions to evaluate.

      Parameters:
      requests - An array of up to 30 requests that you want Verified Permissions to evaluate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • requests

      BatchIsAuthorizedWithTokenRequest.Builder requests(Consumer<BatchIsAuthorizedWithTokenInputItem.Builder>... requests)

      An array of up to 30 requests that you want Verified Permissions to evaluate.

      This is a convenience method that creates an instance of the BatchIsAuthorizedWithTokenInputItem.Builder avoiding the need to create one manually via BatchIsAuthorizedWithTokenInputItem.builder() .

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to requests(List<BatchIsAuthorizedWithTokenInputItem>).

      Parameters:
      requests - a consumer that will call methods on BatchIsAuthorizedWithTokenInputItem.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      BatchIsAuthorizedWithTokenRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      BatchIsAuthorizedWithTokenRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.