GraphFederatedProviderData interface

Package:

azure-devops-extension-api

Represents a set of data used to communicate with a federated provider on behalf of a particular user.

Properties

accessToken	The access token that can be used to communicated with the federated provider on behalf on the target identity, if we were able to successfully acquire one, otherwise <code>null</code>, if we were not.
providerName	The name of the federated provider, e.g. "github.com".
subjectDescriptor	The descriptor of the graph subject to which this federated provider data corresponds.
version	The version number of this federated provider data, which corresponds to when it was last updated. Can be used to prevent returning stale provider data from the cache when the caller is aware of a newer version, such as to prevent local cache poisoning from a remote cache or store. This is the app layer equivalent of the data layer sequence ID.

Property Details

accessToken

The access token that can be used to communicated with the federated provider on behalf on the target identity, if we were able to successfully acquire one, otherwise <code>null</code>, if we were not.

accessToken: string

Property Value

string

providerName

The name of the federated provider, e.g. "github.com".

providerName: string

Property Value

string

subjectDescriptor

The descriptor of the graph subject to which this federated provider data corresponds.

subjectDescriptor: string

Property Value

string

version

The version number of this federated provider data, which corresponds to when it was last updated. Can be used to prevent returning stale provider data from the cache when the caller is aware of a newer version, such as to prevent local cache poisoning from a remote cache or store. This is the app layer equivalent of the data layer sequence ID.

version: number

Property Value

number