Class OAuth2AuthorizationData
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal StringThe identifier of this authorization attempt.final StringThe URL that the user opens to approve access.builder()final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final InstantThe timestamp when the authorization link expires, 10 minutes after the authorization started.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()static Class<? extends OAuth2AuthorizationData.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final StringuserId()The AgentCore Identity user ID that the authorization is for.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The AgentCore Identity user ID that the authorization is for. Store it with your signed-in user and pass it as
userIdentifier.userIdwhen your application callsCompleteResourceTokenAuth.- Returns:
- The AgentCore Identity user ID that the authorization is for. Store it with your signed-in user and pass
it as
userIdentifier.userIdwhen your application callsCompleteResourceTokenAuth.
-
authorizationAttemptId
The identifier of this authorization attempt.
- Returns:
- The identifier of this authorization attempt.
-
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
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<OAuth2AuthorizationData.Builder,OAuth2AuthorizationData> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-