Skip to content

complete_resource_token_auth

Operation

complete_resource_token_auth

complete_resource_token_auth(request: CompleteResourceTokenAuthInput | CompleteResourceTokenAuthInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CompleteResourceTokenAuthInputDict]) -> CompleteResourceTokenAuthOutput

Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.

Parameters:

Name Type Description Default
request CompleteResourceTokenAuthInput | CompleteResourceTokenAuthInputDict | 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[CompleteResourceTokenAuthInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CompleteResourceTokenAuthOutput

An instance of CompleteResourceTokenAuthOutput.

complete_resource_token_auth async

complete_resource_token_auth(request: CompleteResourceTokenAuthInput | CompleteResourceTokenAuthInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CompleteResourceTokenAuthInputDict]) -> CompleteResourceTokenAuthOutput

Confirms the user authentication session for obtaining OAuth2.0 tokens for a resource.

Parameters:

Name Type Description Default
request CompleteResourceTokenAuthInput | CompleteResourceTokenAuthInputDict | 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[CompleteResourceTokenAuthInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CompleteResourceTokenAuthOutput

An instance of CompleteResourceTokenAuthOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CompleteResourceTokenAuthInputDict

Bases: TypedDict

Dictionary form of CompleteResourceTokenAuthInput.

Attributes

session_uri instance-attribute
session_uri: Required[str]

Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.

user_identifier instance-attribute

The OAuth2.0 token or user ID that was used to generate the workload access token used for initiating the user authorization flow to retrieve OAuth2.0 tokens.

CompleteResourceTokenAuthInput dataclass

Bases: _SerdeShape

Dataclass for CompleteResourceTokenAuthInput structure.

Attributes

session_uri class-attribute instance-attribute
session_uri: str | None = ...

Unique identifier for the user's authentication session for retrieving OAuth2 tokens. This ID tracks the authorization flow state across multiple requests and responses during the OAuth2 authentication process.

user_identifier class-attribute instance-attribute
user_identifier: UserIdentifier | None = ...

The OAuth2.0 token or user ID that was used to generate the workload access token used for initiating the user authorization flow to retrieve OAuth2.0 tokens.

Output

CompleteResourceTokenAuthOutput dataclass

Bases: _SerdeShape

Dataclass for CompleteResourceTokenAuthOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

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.