Skip to content

get_workload_access_token

Operation

get_workload_access_token

get_workload_access_token(request: GetWorkloadAccessTokenInput | GetWorkloadAccessTokenInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetWorkloadAccessTokenInputDict]) -> GetWorkloadAccessTokenOutput

Obtains a workload access token for agentic workloads not acting on behalf of a user.

Parameters:

Name Type Description Default
request GetWorkloadAccessTokenInput | GetWorkloadAccessTokenInputDict | 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[GetWorkloadAccessTokenInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetWorkloadAccessTokenOutput

An instance of GetWorkloadAccessTokenOutput.

get_workload_access_token async

get_workload_access_token(request: GetWorkloadAccessTokenInput | GetWorkloadAccessTokenInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetWorkloadAccessTokenInputDict]) -> GetWorkloadAccessTokenOutput

Obtains a workload access token for agentic workloads not acting on behalf of a user.

Parameters:

Name Type Description Default
request GetWorkloadAccessTokenInput | GetWorkloadAccessTokenInputDict | 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[GetWorkloadAccessTokenInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetWorkloadAccessTokenOutput

An instance of GetWorkloadAccessTokenOutput.

Input

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

GetWorkloadAccessTokenInputDict

Bases: TypedDict

Dictionary form of GetWorkloadAccessTokenInput.

Attributes

workload_name instance-attribute
workload_name: Required[str]

The unique identifier for the registered workload.

GetWorkloadAccessTokenInput dataclass

Bases: _SerdeShape

Dataclass for GetWorkloadAccessTokenInput structure.

Attributes

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

The unique identifier for the registered workload.

Output

GetWorkloadAccessTokenOutput dataclass

Bases: _SerdeShape

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

workload_access_token instance-attribute
workload_access_token: str

An opaque token representing the identity of both the workload and the user.