sdk/fidl/fuchsia.auth.oldtokens/README.md

<link rel="stylesheet" href="../style.css" />

[TOC]
# fuchsia.auth.oldtokens

<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div>


## **PROTOCOLS**

## CredentialsProducer {#CredentialsProducer}
*Defined in [fuchsia.auth.oldtokens/credentials_producer.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.auth.oldtokens/credentials_producer.fidl;l=25)*
<p>Clients can connect to this protocol to subscribe to changes in the set of
users linked to this device, as well as the OAuth2 access token associated
with each.</p>
<p>This protocol won't be supported on the majority of devices, and shouldn't
be used without permission from its maintainers.</p>


### GetUpdatedCredentials {#CredentialsProducer.GetUpdatedCredentials}

<p>Get the set of users linked to this device, and their corresponding access
tokens. While the connection to the service remains uninterrumpted, the
method call hangs if it would return the same response as the previous
time it was called by this client. In other words, if the client already
has the most up-to-date credentials, the method acts as a hanging get and
only returns when there's an update to report.</p>



#### Request {#CredentialsProducer.GetUpdatedCredentials_Request}

&lt;EMPTY&gt;


#### Response {#CredentialsProducer.GetUpdatedCredentials_Response}

<table>
    <tr><th>Name</th><th>Type</th></tr>
        <tr>
            <td><code>credentials</code></td>
            <td>
                <code>vector&lt;<a class='link' href='#Credential'>Credential</a>&gt;</code>
            </td>
        </tr>
</table>




## **TABLES**

### Credential  {#Credential data-text="Credential"}


*Defined in [fuchsia.auth.oldtokens/credentials_producer.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.auth.oldtokens/credentials_producer.fidl;l=9)*
<p>The id of a user linked to this device, alongside the current access token
to make requests on the user's behalf.</p>

<table>
    <tr><th>Ordinal</th><th>Field</th><th>Type</th><th>Description</th></tr>
        <tr id="Credential.user_id">
<td><h3 id="Credential.user_id" class="add-link hide-from-toc">1</h3></td>
            <td><code>user_id</code></td>
            <td>
                <code>string</code>
            </td>
            <td><p>Opaque id for the user with which this credential is associated. It is
stable across reconnections to the CredentialsProducer protocol.</p>
</td>
        </tr>
        <tr id="Credential.access_token">
<td><h3 id="Credential.access_token" class="add-link hide-from-toc">2</h3></td>
            <td><code>access_token</code></td>
            <td>
                <code>string</code>
            </td>
            <td><p>OAuth2 access token for this user.</p>
</td>
        </tr>
</table>