introspect_o_auth2_token_with_iam¶
Operation¶
introspect_o_auth2_token_with_iam
¶
introspect_o_auth2_token_with_iam(request: IntrospectOAuth2TokenWithIAMInput | IntrospectOAuth2TokenWithIAMInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[IntrospectOAuth2TokenWithIAMInputDict]) -> IntrospectOAuth2TokenWithIAMOutput
Inspects the metadata and active state of an OAuth 2.0 access token or refresh token. Implements RFC 7662 OAuth 2.0 Token Introspection over a SigV4-authenticated endpoint. Returns the claims associated with a token issued by AWS Sign-In.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
IntrospectOAuth2TokenWithIAMInput | IntrospectOAuth2TokenWithIAMInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[IntrospectOAuth2TokenWithIAMInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
IntrospectOAuth2TokenWithIAMOutput
|
An instance of |
introspect_o_auth2_token_with_iam
async
¶
introspect_o_auth2_token_with_iam(request: IntrospectOAuth2TokenWithIAMInput | IntrospectOAuth2TokenWithIAMInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[IntrospectOAuth2TokenWithIAMInputDict]) -> IntrospectOAuth2TokenWithIAMOutput
Inspects the metadata and active state of an OAuth 2.0 access token or refresh token. Implements RFC 7662 OAuth 2.0 Token Introspection over a SigV4-authenticated endpoint. Returns the claims associated with a token issued by AWS Sign-In.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
IntrospectOAuth2TokenWithIAMInput | IntrospectOAuth2TokenWithIAMInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[IntrospectOAuth2TokenWithIAMInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
IntrospectOAuth2TokenWithIAMOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
IntrospectOAuth2TokenWithIAMInput
dataclass
¶
Bases: _SerdeShape
Input structure for IntrospectOAuth2TokenWithIAM operation RFC 7662 §2.1 introspection request. Contains the token to inspect and an optional hint about the token's type.
Output¶
IntrospectOAuth2TokenWithIAMOutput
dataclass
¶
Bases: _SerdeShape
Output structure for IntrospectOAuth2TokenWithIAM operation RFC 7662
§2.2 introspection response. Only active is required; all other
claims are omitted when the token is inactive.
Attributes¶
account_id
class-attribute
instance-attribute
¶
account_id: str | None = ...
12-digit AWS account ID of the token's subject principal.
active
instance-attribute
¶
active: bool
Indicates whether the token is currently active. Returns "true" only when the token is valid, has not expired, has not been revoked, and belongs to the caller's account.
aud
class-attribute
instance-attribute
¶
aud: str | None = ...
The OAuth resource the token is scoped to. Omitted for refresh tokens. Example: "aws-mcp.amazonaws.com".
client_id
class-attribute
instance-attribute
¶
client_id: str | None = ...
Client identifier for the OAuth 2.0 client that requested the token.
exp
class-attribute
instance-attribute
¶
exp: int | None = ...
Token expiration time as a NumericDate (Unix epoch seconds).
iat
class-attribute
instance-attribute
¶
iat: int | None = ...
Token issuance time as a NumericDate (Unix epoch seconds).
iss
class-attribute
instance-attribute
¶
iss: str | None = ...
Issuer of the token. Always "signin.amazonaws.com" for AWS Sign-In.
nbf
class-attribute
instance-attribute
¶
nbf: int | None = ...
Token "not before" time as a NumericDate (Unix epoch seconds).
resource
class-attribute
instance-attribute
¶
resource: str | None = ...
The OAuth resource the token is scoped to. Only present for refresh token introspection.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.
signin_session
class-attribute
instance-attribute
¶
signin_session: str | None = ...
AWS Sign-In session ARN bound to the token, of the form arn:aws:signin:{region}:{account}:session/{uuid}.
sub
class-attribute
instance-attribute
¶
sub: str | None = ...
The IAM principal Amazon Resource Name (ARN). For assumed-role sessions, this is the session ARN.