ATAS.Indicators.IAtasAccessTokenProvider Interface Reference

Gives an indicator the access token of the ATAS account the platform is signed in with: an access token of the ATAS identity server (id.atas.net), which ATAS data services check before they answer. The Options X-Ray indicators send it to the options data server, which serves ATAS accounts only. Resolved through IIndicatorServiceProvider; hosts that do not register it have no token to give, and so does a host whose account the identity server does not know. More...

Public Member Functions
Task< string?>	GetAccessTokenAsync (CancellationToken cancellationToken)
	Returns a valid access token, or null when there is none: not signed in, a white label build, the identity server rejected the account or is unreachable. Never throws.
void	Invalidate ()
	Drops the cached token after a service rejected it, so the next call gets a new one.

Detailed Description

Gives an indicator the access token of the ATAS account the platform is signed in with: an access token of the ATAS identity server (id.atas.net), which ATAS data services check before they answer. The Options X-Ray indicators send it to the options data server, which serves ATAS accounts only. Resolved through IIndicatorServiceProvider; hosts that do not register it have no token to give, and so does a host whose account the identity server does not know.

The token opens ATAS services in the name of the account. An indicator may send it to an ATAS service over HTTPS and nowhere else, and must not store it: it is asked for before each request and lives for about an hour.

The Options X-Ray pack is built apart from the platform and finds this interface by its full name and the two members by theirs: renaming any of them leaves its indicators without data once the open API of the options data server is closed. See docs/PLAT-5216.

Member Function Documentation

GetAccessTokenAsync()

Task< string?> ATAS.Indicators.IAtasAccessTokenProvider.GetAccessTokenAsync

(

CancellationToken

cancellationToken

)

Returns a valid access token, or null when there is none: not signed in, a white label build, the identity server rejected the account or is unreachable. Never throws.

Invalidate()

void ATAS.Indicators.IAtasAccessTokenProvider.Invalidate

(

)

Drops the cached token after a service rejected it, so the next call gets a new one.

---

The documentation for this interface was generated from the following file:

• IAtasAccessTokenProvider.cs