Struct aws_sdk_cognitoidentity::client::fluent_builders::GetOpenIdTokenForDeveloperIdentity
source · [−]pub struct GetOpenIdTokenForDeveloperIdentity { /* private fields */ }
Expand description
Fluent builder constructing a request to GetOpenIdTokenForDeveloperIdentity
.
Registers (or retrieves) a Cognito IdentityId
and an OpenID Connect token for a user authenticated by your backend authentication process. Supplying multiple logins will create an implicit linked account. You can only specify one developer provider as part of the Logins
map, which is linked to the identity pool. The developer provider is the "domain" by which Cognito will refer to your users.
You can use GetOpenIdTokenForDeveloperIdentity
to create a new identity and to link new logins (that is, user credentials issued by a public provider or developer provider) to an existing identity. When you want to create a new identity, the IdentityId
should be null. When you want to associate a new login with an existing authenticated/unauthenticated identity, you can do so by providing the existing IdentityId
. This API will create the identity in the specified IdentityPoolId
.
You must use AWS Developer credentials to call this API.
Implementations
sourceimpl GetOpenIdTokenForDeveloperIdentity
impl GetOpenIdTokenForDeveloperIdentity
sourcepub async fn send(
self
) -> Result<GetOpenIdTokenForDeveloperIdentityOutput, SdkError<GetOpenIdTokenForDeveloperIdentityError>>
pub async fn send(
self
) -> Result<GetOpenIdTokenForDeveloperIdentityOutput, SdkError<GetOpenIdTokenForDeveloperIdentityError>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub fn identity_pool_id(self, input: impl Into<String>) -> Self
pub fn identity_pool_id(self, input: impl Into<String>) -> Self
An identity pool ID in the format REGION:GUID.
sourcepub fn set_identity_pool_id(self, input: Option<String>) -> Self
pub fn set_identity_pool_id(self, input: Option<String>) -> Self
An identity pool ID in the format REGION:GUID.
sourcepub fn identity_id(self, input: impl Into<String>) -> Self
pub fn identity_id(self, input: impl Into<String>) -> Self
A unique identifier in the format REGION:GUID.
sourcepub fn set_identity_id(self, input: Option<String>) -> Self
pub fn set_identity_id(self, input: Option<String>) -> Self
A unique identifier in the format REGION:GUID.
sourcepub fn logins(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn logins(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to Logins
.
To override the contents of this collection use set_logins
.
A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier"
. The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
sourcepub fn set_logins(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_logins(self, input: Option<HashMap<String, String>>) -> Self
A set of optional name-value pairs that map provider names to provider tokens. Each name-value pair represents a user from a public provider or developer provider. If the user is from a developer provider, the name-value pair will follow the syntax "developer_provider_name": "developer_user_identifier"
. The developer provider is the "domain" by which Cognito will refer to your users; you provided this domain while creating/updating the identity pool. The developer user identifier is an identifier from your backend that uniquely identifies a user. When you create an identity pool, you can specify the supported logins.
Adds a key-value pair to PrincipalTags
.
To override the contents of this collection use set_principal_tags
.
Use this operation to configure attribute mappings for custom providers.
Use this operation to configure attribute mappings for custom providers.
sourcepub fn token_duration(self, input: i64) -> Self
pub fn token_duration(self, input: i64) -> Self
The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.
Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.
sourcepub fn set_token_duration(self, input: Option<i64>) -> Self
pub fn set_token_duration(self, input: Option<i64>) -> Self
The expiration time of the token, in seconds. You can specify a custom expiration time for the token so that you can cache it. If you don't provide an expiration time, the token is valid for 15 minutes. You can exchange the token with Amazon STS for temporary AWS credentials, which are valid for a maximum of one hour. The maximum token duration you can set is 24 hours. You should take care in setting the expiration time for a token, as there are significant security implications: an attacker could use a leaked token to access your AWS resources for the token's duration.
Please provide for a small grace period, usually no more than 5 minutes, to account for clock skew.
Trait Implementations
sourceimpl Clone for GetOpenIdTokenForDeveloperIdentity
impl Clone for GetOpenIdTokenForDeveloperIdentity
sourcefn clone(&self) -> GetOpenIdTokenForDeveloperIdentity
fn clone(&self) -> GetOpenIdTokenForDeveloperIdentity
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for GetOpenIdTokenForDeveloperIdentity
impl Send for GetOpenIdTokenForDeveloperIdentity
impl Sync for GetOpenIdTokenForDeveloperIdentity
impl Unpin for GetOpenIdTokenForDeveloperIdentity
impl !UnwindSafe for GetOpenIdTokenForDeveloperIdentity
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more