Class OAuth2AuthorizationData

java.lang.Object
software.amazon.awssdk.services.agentregistrycontrol.model.OAuth2AuthorizationData
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OAuth2AuthorizationData.Builder,OAuth2AuthorizationData>

@Generated("software.amazon.awssdk:codegen") public final class OAuth2AuthorizationData extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OAuth2AuthorizationData.Builder,OAuth2AuthorizationData>

An OAuth 2.0 authorization that waits for a user's approval. The user opens authorizationUrl and approves access on GitHub. Amazon Bedrock AgentCore Identity then redirects the browser to the source's returnUrl. There, your application completes the authorization by calling the AgentCore Identity CompleteResourceTokenAuth operation with userId. If the source has no returnUrl, the user returns to the Amazon Web Services Agent Registry console, which completes the authorization. After the authorization completes, the registry synchronizes the record without another request. If the user doesn't approve access before expiresAt, the record moves to CREATE_FAILED or UPDATE_FAILED. To start again, call UpdateRegistryRecord with triggerSynchronization.

See Also:
  • Method Details

    • authorizationUrl

      public final String authorizationUrl()

      The URL that the user opens to approve access. The link is valid for up to 10 minutes. Treat it as sensitive and give it only to the user who approves access.

      Returns:
      The URL that the user opens to approve access. The link is valid for up to 10 minutes. Treat it as sensitive and give it only to the user who approves access.
    • userId

      public final String userId()

      The AgentCore Identity user ID that the authorization is for. Store it with your signed-in user and pass it as userIdentifier.userId when your application calls CompleteResourceTokenAuth.

      Returns:
      The AgentCore Identity user ID that the authorization is for. Store it with your signed-in user and pass it as userIdentifier.userId when your application calls CompleteResourceTokenAuth.
    • authorizationAttemptId

      public final String authorizationAttemptId()

      The identifier of this authorization attempt.

      Returns:
      The identifier of this authorization attempt.
    • expiresAt

      public final Instant expiresAt()

      The timestamp when the authorization link expires, 10 minutes after the authorization started. A request that joins an authorization in progress gets less time, and the link might stop working shortly before this time.

      Returns:
      The timestamp when the authorization link expires, 10 minutes after the authorization started. A request that joins an authorization in progress gets less time, and the link might stop working shortly before this time.
    • toBuilder

      public OAuth2AuthorizationData.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<OAuth2AuthorizationData.Builder,OAuth2AuthorizationData>
      Returns:
      a builder for type T
    • builder

      public static OAuth2AuthorizationData.Builder builder()
    • serializableBuilderClass

      public static Class<? extends OAuth2AuthorizationData.Builder> serializableBuilderClass()
    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object
    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object
    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object
    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.