UserTokenClient Class

Client for managing user tokens in Teams.

Initialize the UserTokenClient.

Constructor

UserTokenClient(options: Client | ClientOptions | None = None, api_client_settings: ApiClientSettings | None = None, *, cloud: CloudEnvironment | None = None)

Parameters

Name	Description
options	Optional Client or ClientOptions instance. If not provided, a default Client will be created. Default value: None
api_client_settings	Optional API client settings. Default value: None

Keyword-Only Parameters

Name	Description
cloud	Default value: None

Methods

exchange	Exchange a user token.
get	Get a user token.
get_aad	Get AAD tokens for a user.
get_status	Get token status for a user.
sign_out	Sign out a user.

exchange

Exchange a user token.

async exchange(params: ExchangeUserTokenParams) -> TokenResponse

Parameters

Name	Description
params Required	Parameters for exchanging the token.

Returns

Type	Description
	TokenResponse containing the exchanged token.

get

Get a user token.

async get(params: GetUserTokenParams) -> TokenResponse

Parameters

Name	Description
params Required	Parameters for getting the user token.

Returns

Type	Description
	TokenResponse containing the user token.

get_aad

Get AAD tokens for a user.

async get_aad(params: GetUserAADTokenParams) -> Dict[str, TokenResponse]

Parameters

Name	Description
params Required	Parameters for getting AAD tokens.

Returns

Type	Description
	Dictionary mapping resource URLs to token responses.

get_status

Get token status for a user.

async get_status(params: GetUserTokenStatusParams) -> List[TokenStatus]

Parameters

Name	Description
params Required	Parameters for getting token status.

Returns

Type	Description
	List of token statuses.

sign_out

Sign out a user.

async sign_out(params: SignOutUserParams) -> None

Parameters

Name	Description
params Required	Parameters for signing out the user.