Skip to content

send_delegation_token

Operation

send_delegation_token

send_delegation_token(request: SendDelegationTokenInput | SendDelegationTokenInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SendDelegationTokenInputDict]) -> SendDelegationTokenOutput

Sends the exchange token for an accepted delegation request.

The exchange token is sent to the partner via an asynchronous notification channel, established by the partner.

The delegation request must be in the ACCEPTED state when calling this API. After the SendDelegationToken API call is successful, the request transitions to a FINALIZED state and cannot be rolled back. However, a user may reject an accepted request before the SendDelegationToken API is called.

For more details, see Managing Permissions for Delegation Requests.

Parameters:

Name Type Description Default
request SendDelegationTokenInput | SendDelegationTokenInputDict | 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[SendDelegationTokenInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
SendDelegationTokenOutput

An instance of SendDelegationTokenOutput.

send_delegation_token async

send_delegation_token(request: SendDelegationTokenInput | SendDelegationTokenInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[SendDelegationTokenInputDict]) -> SendDelegationTokenOutput

Sends the exchange token for an accepted delegation request.

The exchange token is sent to the partner via an asynchronous notification channel, established by the partner.

The delegation request must be in the ACCEPTED state when calling this API. After the SendDelegationToken API call is successful, the request transitions to a FINALIZED state and cannot be rolled back. However, a user may reject an accepted request before the SendDelegationToken API is called.

For more details, see Managing Permissions for Delegation Requests.

Parameters:

Name Type Description Default
request SendDelegationTokenInput | SendDelegationTokenInputDict | 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[SendDelegationTokenInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
SendDelegationTokenOutput

An instance of SendDelegationTokenOutput.

Input

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

SendDelegationTokenInputDict

Bases: TypedDict

Dictionary form of SendDelegationTokenInput.

Attributes

delegation_request_id instance-attribute
delegation_request_id: Required[str]

The unique identifier of the delegation request for which to send the token.

SendDelegationTokenInput dataclass

Bases: _SerdeShape

Dataclass for SendDelegationTokenInput structure.

Attributes

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

The unique identifier of the delegation request for which to send the token.

Output

SendDelegationTokenOutput dataclass

Bases: _SerdeShape

Dataclass for SendDelegationTokenOutput 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.