> ## Documentation Index
> Fetch the complete documentation index at: https://www.canva.dev/docs/apps/llms.txt
> Use this file to discover all available pages before exploring further.

# auth.initOauth

API reference for the auth.initOauth method.

NOTE: **This API is a preview**. Preview APIs are unstable and may change without warning. You can't release public apps using this API until it's stable.

<Tabs>
  <Tab name="initOauth">
    Creates a client for authenticating users with OAuth.

    To learn more, see [https://www.canva.dev/docs/apps/authenticating-users/oauth](https://www.canva.dev/docs/apps/authenticating-users/oauth).

    ## Usage: Initialize an OAuth client

    ```typescript
    import { auth } from '@canva/user';

    const oauth = auth.initOauth();
    ```

    ## Returns

    A client for authorizing users with OAuth.

    <Prop.List>
      <Prop name="requestAuthorization" required type="function" sourceLineNumbers={[425]}>
        Starts an OAuth authorization flow.

        **Parameters**

        <Prop.List>
          <Prop name="request" type="AuthorizationRequest<T>" sourceLineNumbers={[425]}>
            Options for configuring the authorization flow.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>request</strong></>}>
              <Prop.List>
                <Prop name="queryParams" type="ExcludeKeys<T, ForbiddenKey>" sourceLineNumbers={[140]}>
                  Query parameters to append to the URL of the request.

                  The following keys are not allowed in this object:

                  * `"client_id"`
                  * `"redirect_uri"`
                  * `"scope"`
                  * `"state"`
                  * `"response_type"`
                  * `"code_challenge"`
                  * `"code_challenge_method"`
                  * `"client_secret"`
                </Prop>

                <Prop name="scope" type="Set<string>" sourceLineNumbers={[144]}>
                  The list of scopes to request access to.
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>

        **Returns**

        The result of the authorization flow. This is a `Promise` that resolves with the following object:

        <Tabs>
          <Tab name="AuthorizationCompleted">
            The result when a user successfully completes an OAuth authorization flow.

            <Prop.List>
              <Prop name="status" required type="string" sourceLineNumbers={[125]}>
                The status of the authorization flow.

                The only valid value is `"completed"`.
              </Prop>

              <Prop name="scope" required type="Set<string>" sourceLineNumbers={[129]}>
                The scopes associated with the user.
              </Prop>
            </Prop.List>
          </Tab>

          <Tab name="AuthorizationAborted">
            The result when a user fails to complete an OAuth authorization flow.

            <Prop.List>
              <Prop name="status" required type="string" sourceLineNumbers={[114]}>
                The status of the authorization flow.

                The only valid value is `"aborted"`.
              </Prop>
            </Prop.List>
          </Tab>
        </Tabs>

        <Prop.Extras>
          **Examples**

          **Start an authorization flow**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Start an authorization flow
          const response = await oauth.requestAuthorization();
          ```

          **Start an authorization flow with specific scopes**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Define the scopes to request
          const scope = new Set(['PLACEHOLDER_SCOPE_1', 'PLACEHOLDER_SCOPE_2']);

          // Start an authorization flow with specific scopes
          const response = await oauth.requestAuthorization({ scope });
          ```

          **Start an authorization flow with custom query parameters**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Define the query parameters to append to the URL of the request
          const queryParams = new Map([['custom_param', 'custom_value']]);

          // Start an authorization flow with custom query parameters
          const response = await oauth.requestAuthorization({ queryParams });
          ```

          **Handle the result of a authorization flow**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Start an authorization flow
          const response = await oauth.requestAuthorization();

          if (response.status === 'completed') {
           // The user completed the authorization flow
          }

          if(response.status === 'aborted') {
           // The user did not complete the authorization flow
          }
          ```
        </Prop.Extras>
      </Prop>

      <Prop name="getAccessToken" required type="function" sourceLineNumbers={[478]}>
        Gets the access token and scopes for the current user.

        * When a token expires, it's automatically refreshed by Canva.
        * The token is cached by Canva, so the app's frontend shouldn't store the token.

        **Parameters**

        <Prop.List>
          <Prop name="request" type="AccessTokenRequest" sourceLineNumbers={[478]}>
            Options for requesting an access token for the current user.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>request</strong></>}>
              <Prop.List>
                <Prop name="forceRefresh" type="boolean" sourceLineNumbers={[12]}>
                  If `true`, the access token will be refreshed, even if it hasn't expired.

                  By default, access tokens are automatically refreshed after expiry.
                </Prop>

                <Prop name="scope" type="Set<string>" sourceLineNumbers={[16]}>
                  The scopes associated with the access token.
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>

        **Returns**

        The access token and scopes for the current user, or `null` if the user isn't authorized. This is a `Promise` that resolves with either `undefined` or the following object:

        <Prop.List>
          <Prop name="token" required type="string" sourceLineNumbers={[30]}>
            The access token for the current user.
          </Prop>

          <Prop name="scope" required type="Set<string>" sourceLineNumbers={[34]}>
            The scopes associated with the current user's access token.
          </Prop>

          <Prop name="subdomain" state="preview" type="string" sourceLineNumbers={[39]}>
            The subdomain associated with the access token.
          </Prop>
        </Prop.List>

        <Prop.Extras>
          **Examples**

          **Get the access token of the current user**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Get an access token for the user
          const token = await oauth.getAccessToken();
          ```

          **Check if the user is authorized**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Get an access token for the user
          const token = await oauth.getAccessToken();

          if (token) {
           // The user is authorized
          } else {
           // The user is not authorized
          }
          ```

          **Forcefully refresh an access token**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Forcefully refresh an access token
          const token = await oauth.getAccessToken({ forceRefresh: true });
          ```
        </Prop.Extras>
      </Prop>

      <Prop name="deauthorize" required type="function" sourceLineNumbers={[500]}>
        Disconnects the user from the identity provider (IdP).

        If token revocation is supported by the OAuth provider, the refresh and access tokens will be revoked.

        **Returns**

        An empty `Promise` that resolves once the user is disconnected from the IdP.

        `Promise<void>`

        <Prop.Extras>
          **Example: Disconnect an authorized user from the identity provider (IdP)**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Disconnect the user from the IdP
          await oauth.deauthorize();
          ```
        </Prop.Extras>
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="InitSingleAccountOauthOptions">
    Initializes an OAuth client for a single account.

    ## Parameters

    <Prop.List>
      <Prop name="options" required state="preview" type="InitSingleAccountOauthOptions" sourceLineNumbers={[98]}>
        Options for initializing the oauth client

        <PillAccordion defaultExpanded={true} title={<>Properties of <strong>options</strong></>}>
          <Prop.List>
            <Prop name="provider" required type="string" sourceLineNumbers={[268]}>
              The provider to initialize the oauth client for
            </Prop>

            <Prop name="type" required type="string" sourceLineNumbers={[272]}>
              The type of oauth client to initialize

              The only valid value is `"single_account"`.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>
    </Prop.List>

    ## Returns

    A client for authorizing users with OAuth.

    <Prop.List>
      <Prop name="requestAuthorization" required type="function" sourceLineNumbers={[425]}>
        Starts an OAuth authorization flow.

        **Parameters**

        <Prop.List>
          <Prop name="request" type="AuthorizationRequest<T>" sourceLineNumbers={[425]}>
            Options for configuring the authorization flow.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>request</strong></>}>
              <Prop.List>
                <Prop name="queryParams" type="ExcludeKeys<T, ForbiddenKey>" sourceLineNumbers={[140]}>
                  Query parameters to append to the URL of the request.

                  The following keys are not allowed in this object:

                  * `"client_id"`
                  * `"redirect_uri"`
                  * `"scope"`
                  * `"state"`
                  * `"response_type"`
                  * `"code_challenge"`
                  * `"code_challenge_method"`
                  * `"client_secret"`
                </Prop>

                <Prop name="scope" type="Set<string>" sourceLineNumbers={[144]}>
                  The list of scopes to request access to.
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>

        **Returns**

        The result of the authorization flow. This is a `Promise` that resolves with the following object:

        <Tabs>
          <Tab name="AuthorizationCompleted">
            The result when a user successfully completes an OAuth authorization flow.

            <Prop.List>
              <Prop name="status" required type="string" sourceLineNumbers={[125]}>
                The status of the authorization flow.

                The only valid value is `"completed"`.
              </Prop>

              <Prop name="scope" required type="Set<string>" sourceLineNumbers={[129]}>
                The scopes associated with the user.
              </Prop>
            </Prop.List>
          </Tab>

          <Tab name="AuthorizationAborted">
            The result when a user fails to complete an OAuth authorization flow.

            <Prop.List>
              <Prop name="status" required type="string" sourceLineNumbers={[114]}>
                The status of the authorization flow.

                The only valid value is `"aborted"`.
              </Prop>
            </Prop.List>
          </Tab>
        </Tabs>

        <Prop.Extras>
          **Examples**

          **Start an authorization flow**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Start an authorization flow
          const response = await oauth.requestAuthorization();
          ```

          **Start an authorization flow with specific scopes**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Define the scopes to request
          const scope = new Set(['PLACEHOLDER_SCOPE_1', 'PLACEHOLDER_SCOPE_2']);

          // Start an authorization flow with specific scopes
          const response = await oauth.requestAuthorization({ scope });
          ```

          **Start an authorization flow with custom query parameters**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Define the query parameters to append to the URL of the request
          const queryParams = new Map([['custom_param', 'custom_value']]);

          // Start an authorization flow with custom query parameters
          const response = await oauth.requestAuthorization({ queryParams });
          ```

          **Handle the result of a authorization flow**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Start an authorization flow
          const response = await oauth.requestAuthorization();

          if (response.status === 'completed') {
           // The user completed the authorization flow
          }

          if(response.status === 'aborted') {
           // The user did not complete the authorization flow
          }
          ```
        </Prop.Extras>
      </Prop>

      <Prop name="getAccessToken" required type="function" sourceLineNumbers={[478]}>
        Gets the access token and scopes for the current user.

        * When a token expires, it's automatically refreshed by Canva.
        * The token is cached by Canva, so the app's frontend shouldn't store the token.

        **Parameters**

        <Prop.List>
          <Prop name="request" type="AccessTokenRequest" sourceLineNumbers={[478]}>
            Options for requesting an access token for the current user.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>request</strong></>}>
              <Prop.List>
                <Prop name="forceRefresh" type="boolean" sourceLineNumbers={[12]}>
                  If `true`, the access token will be refreshed, even if it hasn't expired.

                  By default, access tokens are automatically refreshed after expiry.
                </Prop>

                <Prop name="scope" type="Set<string>" sourceLineNumbers={[16]}>
                  The scopes associated with the access token.
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>

        **Returns**

        The access token and scopes for the current user, or `null` if the user isn't authorized. This is a `Promise` that resolves with either `undefined` or the following object:

        <Prop.List>
          <Prop name="token" required type="string" sourceLineNumbers={[30]}>
            The access token for the current user.
          </Prop>

          <Prop name="scope" required type="Set<string>" sourceLineNumbers={[34]}>
            The scopes associated with the current user's access token.
          </Prop>

          <Prop name="subdomain" state="preview" type="string" sourceLineNumbers={[39]}>
            The subdomain associated with the access token.
          </Prop>
        </Prop.List>

        <Prop.Extras>
          **Examples**

          **Get the access token of the current user**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Get an access token for the user
          const token = await oauth.getAccessToken();
          ```

          **Check if the user is authorized**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Get an access token for the user
          const token = await oauth.getAccessToken();

          if (token) {
           // The user is authorized
          } else {
           // The user is not authorized
          }
          ```

          **Forcefully refresh an access token**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Forcefully refresh an access token
          const token = await oauth.getAccessToken({ forceRefresh: true });
          ```
        </Prop.Extras>
      </Prop>

      <Prop name="deauthorize" required type="function" sourceLineNumbers={[500]}>
        Disconnects the user from the identity provider (IdP).

        If token revocation is supported by the OAuth provider, the refresh and access tokens will be revoked.

        **Returns**

        An empty `Promise` that resolves once the user is disconnected from the IdP.

        `Promise<void>`

        <Prop.Extras>
          **Example: Disconnect an authorized user from the identity provider (IdP)**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Disconnect the user from the IdP
          await oauth.deauthorize();
          ```
        </Prop.Extras>
      </Prop>
    </Prop.List>
  </Tab>

  <Tab name="InitMultiAccountOauthOptions">
    Initializes an OAuth client for a multi account.

    ## Parameters

    <Prop.List>
      <Prop name="options" required state="preview" type="InitMultiAccountOauthOptions" sourceLineNumbers={[103]}>
        Options for initializing the oauth client

        <PillAccordion defaultExpanded={true} title={<>Properties of <strong>options</strong></>}>
          <Prop.List>
            <Prop name="provider" required type="string" sourceLineNumbers={[253]}>
              The provider to initialize the oauth client for
            </Prop>

            <Prop name="type" required type="string" sourceLineNumbers={[257]}>
              The type of oauth client to initialize

              The only valid value is `"multi_account"`.
            </Prop>
          </Prop.List>
        </PillAccordion>
      </Prop>
    </Prop.List>

    ## Returns

    A client for authorizing users with OAuth.

    <Prop.List>
      <Prop name="requestAuthorization" required type="function" sourceLineNumbers={[347]}>
        **Parameters**

        <Prop.List>
          <Prop name="request" type="AuthorizationRequest<T>" sourceLineNumbers={[347]}>
            Options for configuring the authorization flow.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>request</strong></>}>
              <Prop.List>
                <Prop name="queryParams" type="ExcludeKeys<T, ForbiddenKey>" sourceLineNumbers={[140]}>
                  Query parameters to append to the URL of the request.

                  The following keys are not allowed in this object:

                  * `"client_id"`
                  * `"redirect_uri"`
                  * `"scope"`
                  * `"state"`
                  * `"response_type"`
                  * `"code_challenge"`
                  * `"code_challenge_method"`
                  * `"client_secret"`
                </Prop>

                <Prop name="scope" type="Set<string>" sourceLineNumbers={[144]}>
                  The list of scopes to request access to.
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>

        **Returns**

        The result of the authorization flow. This is a `Promise` that resolves with the following object:

        <Tabs>
          <Tab name="AuthorizationCompleted">
            The result when a user successfully completes an OAuth authorization flow.

            <Prop.List>
              <Prop name="status" required type="string" sourceLineNumbers={[125]}>
                The status of the authorization flow.

                The only valid value is `"completed"`.
              </Prop>

              <Prop name="scope" required type="Set<string>" sourceLineNumbers={[129]}>
                The scopes associated with the user.
              </Prop>
            </Prop.List>
          </Tab>

          <Tab name="AuthorizationAborted">
            The result when a user fails to complete an OAuth authorization flow.

            <Prop.List>
              <Prop name="status" required type="string" sourceLineNumbers={[114]}>
                The status of the authorization flow.

                The only valid value is `"aborted"`.
              </Prop>
            </Prop.List>
          </Tab>
        </Tabs>

        <Prop.Extras>
          **Examples**

          **Start an authorization flow**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth({ type: 'multi_account' });

          // Start an authorization flow
          const response = await oauth.requestAuthorization();
          ```

          **Start an authorization flow with specific scopes**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth({ type: 'multi_account' });

          // Define the scopes to request
          const scope = new Set(['PLACEHOLDER_SCOPE_1', 'PLACEHOLDER_SCOPE_2']);

          // Start an authorization flow with specific scopes
          const response = await oauth.requestAuthorization({ scope });
          ```

          **Start an authorization flow with custom query parameters**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Define the query parameters to append to the URL of the request
          const queryParams = new Map([['custom_param', 'custom_value']]);

          // Start an authorization flow with custom query parameters
          const response = await oauth.requestAuthorization({ queryParams });
          ```

          **Handle the result of a authorization flow**

          ```ts
          import { auth } from "@canva/user";

          // Initialize an OAuth client
          const oauth = auth.initOauth();

          // Start an authorization flow
          const response = await oauth.requestAuthorization();

          if (response.status === 'completed') {
           // The user completed the authorization flow
          }

          if(response.status === 'aborted') {
           // The user did not complete the authorization flow
          }
          ```
        </Prop.Extras>
      </Prop>

      <Prop name="getAccounts" required type="function" sourceLineNumbers={[348]}>
        **Returns**

        The result of requesting a list of accounts. This is a `Promise` that resolves with the following object:

        <Prop.List>
          <Prop name="accounts" required state="preview" type="OauthAccount[]" sourceLineNumbers={[242]}>
            A client for managing a single OAuth account.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>accounts</strong></>}>
              <Prop.List>
                <Prop name="id" required type="string" sourceLineNumbers={[511]}>
                  The ID of the account.
                </Prop>

                <Prop name="displayName" required type="string" sourceLineNumbers={[519]}>
                  The display name of the account.
                </Prop>

                <Prop name="expired" required type="boolean" sourceLineNumbers={[527]}>
                  Whether the access token for the account has expired and there is no associated refresh token.
                </Prop>

                <Prop name="getAccessToken" required type="function" sourceLineNumbers={[591]}>
                  Gets the access token and scopes for the current OAuth account.

                  * When a token expires, it's automatically refreshed by Canva.
                  * The token is cached by Canva, so the app's frontend shouldn't store the token.

                  **Parameters**

                  <Prop.List>
                    <Prop name="request" type="AccessTokenRequest" sourceLineNumbers={[591]}>
                      Options for requesting an access token for the current OAuth account.

                      <PillAccordion defaultExpanded={false} title={<>Properties of <strong>request</strong></>}>
                        <Prop.List>
                          <Prop name="forceRefresh" type="boolean" sourceLineNumbers={[12]}>
                            If `true`, the access token will be refreshed, even if it hasn't expired.

                            By default, access tokens are automatically refreshed after expiry.
                          </Prop>

                          <Prop name="scope" type="Set<string>" sourceLineNumbers={[16]}>
                            The scopes associated with the access token.
                          </Prop>
                        </Prop.List>
                      </PillAccordion>
                    </Prop>
                  </Prop.List>

                  **Returns**

                  The access token and scopes for the current OAuth account, or `null` if the account isn't authorized. This is a `Promise` that resolves with either `undefined` or the following object:

                  <Prop.List>
                    <Prop name="token" required type="string" sourceLineNumbers={[30]}>
                      The access token for the current user.
                    </Prop>

                    <Prop name="scope" required type="Set<string>" sourceLineNumbers={[34]}>
                      The scopes associated with the current user's access token.
                    </Prop>

                    <Prop name="subdomain" state="preview" type="string" sourceLineNumbers={[39]}>
                      The subdomain associated with the access token.
                    </Prop>
                  </Prop.List>

                  <Prop.Extras>
                    **Examples**

                    **Get the access token of the current OAuth account**

                    ```ts
                    import { auth } from "@canva/user";

                    // Initialize an OAuth client
                    const oauth = auth.initOauth({ type: 'multi_account' });

                    // Get the account
                    const account = await oauth.getAccount({ accountId: '123' });

                    // Get an access token for the account
                    const token = await oauth.getAccessToken();
                    ```

                    **Check if the account is authorized**

                    ```ts
                    import { auth } from "@canva/user";

                    // Initialize an OAuth client
                    const oauth = auth.initOauth({ type: 'multi_account' });

                    // Get an access token for the account
                    const account = await oauth.getAccount({ accountId: '123' });
                    const token = await account.getAccessToken();

                    if (token) {
                     // The account is authorized
                    } else {
                     // The account is not authorized
                    }
                    ```

                    **Forcefully refresh an access token**

                    ```ts
                    import { auth } from "@canva/user";

                    // Initialize an OAuth client
                    const oauth = auth.initOauth({ type: 'multi_account' });

                    // Get the account
                    const account = await oauth.getAccount({ accountId: '123' });

                    // Forcefully refresh an access token
                    const token = await account.getAccessToken({ forceRefresh: true });
                    ```
                  </Prop.Extras>
                </Prop>

                <Prop name="deauthorize" required type="function" sourceLineNumbers={[613]}>
                  Deauthorizes the account.

                  **Returns**

                  An empty `Promise` that resolves once the account is deauthorized.

                  `Promise<void>`

                  <Prop.Extras>
                    **Example: Deauthorize an authorized account**

                    ```ts
                    import { auth } from "@canva/user";

                    // Initialize an OAuth client
                    const oauth = auth.initOauth({ type: 'multi_account' });

                    // Get the account
                    const account = await oauth.getAccount({ accountId: '123' });

                    // Deauthorize the account
                    await account.deauthorize();
                    ```
                  </Prop.Extras>
                </Prop>

                <Prop name="principal" type="string" sourceLineNumbers={[515]}>
                  The principal of the account (e.g., email, username).
                </Prop>

                <Prop name="avatarUrl" type="string" sourceLineNumbers={[523]}>
                  The avatar URL of the account.
                </Prop>

                <Prop name="subdomain" type="string" sourceLineNumbers={[531]}>
                  The subdomain associated with the OAuth account.
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>
      </Prop>

      <Prop name="getAccount" required type="function" sourceLineNumbers={[349]}>
        **Parameters**

        <Prop.List>
          <Prop name="request" required state="preview" type="GetAccountRequest" sourceLineNumbers={[349]}>
            Options for requesting a single OAuth account.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>request</strong></>}>
              <Prop.List />
            </PillAccordion>
          </Prop>
        </Prop.List>

        **Returns**

        The result of requesting a single account. This is a `Promise` that resolves with the following object:

        <Prop.List>
          <Prop name="account" required state="preview" type="OauthAccount" sourceLineNumbers={[234]}>
            A client for managing a single OAuth account.

            <PillAccordion defaultExpanded={false} title={<>Properties of <strong>account</strong></>}>
              <Prop.List>
                <Prop name="id" required type="string" sourceLineNumbers={[511]}>
                  The ID of the account.
                </Prop>

                <Prop name="displayName" required type="string" sourceLineNumbers={[519]}>
                  The display name of the account.
                </Prop>

                <Prop name="expired" required type="boolean" sourceLineNumbers={[527]}>
                  Whether the access token for the account has expired and there is no associated refresh token.
                </Prop>

                <Prop name="getAccessToken" required type="function" sourceLineNumbers={[591]}>
                  Gets the access token and scopes for the current OAuth account.

                  * When a token expires, it's automatically refreshed by Canva.
                  * The token is cached by Canva, so the app's frontend shouldn't store the token.

                  **Parameters**

                  <Prop.List>
                    <Prop name="request" type="AccessTokenRequest" sourceLineNumbers={[591]}>
                      Options for requesting an access token for the current OAuth account.

                      <PillAccordion defaultExpanded={false} title={<>Properties of <strong>request</strong></>}>
                        <Prop.List>
                          <Prop name="forceRefresh" type="boolean" sourceLineNumbers={[12]}>
                            If `true`, the access token will be refreshed, even if it hasn't expired.

                            By default, access tokens are automatically refreshed after expiry.
                          </Prop>

                          <Prop name="scope" type="Set<string>" sourceLineNumbers={[16]}>
                            The scopes associated with the access token.
                          </Prop>
                        </Prop.List>
                      </PillAccordion>
                    </Prop>
                  </Prop.List>

                  **Returns**

                  The access token and scopes for the current OAuth account, or `null` if the account isn't authorized. This is a `Promise` that resolves with either `undefined` or the following object:

                  <Prop.List>
                    <Prop name="token" required type="string" sourceLineNumbers={[30]}>
                      The access token for the current user.
                    </Prop>

                    <Prop name="scope" required type="Set<string>" sourceLineNumbers={[34]}>
                      The scopes associated with the current user's access token.
                    </Prop>

                    <Prop name="subdomain" state="preview" type="string" sourceLineNumbers={[39]}>
                      The subdomain associated with the access token.
                    </Prop>
                  </Prop.List>

                  <Prop.Extras>
                    **Examples**

                    **Get the access token of the current OAuth account**

                    ```ts
                    import { auth } from "@canva/user";

                    // Initialize an OAuth client
                    const oauth = auth.initOauth({ type: 'multi_account' });

                    // Get the account
                    const account = await oauth.getAccount({ accountId: '123' });

                    // Get an access token for the account
                    const token = await oauth.getAccessToken();
                    ```

                    **Check if the account is authorized**

                    ```ts
                    import { auth } from "@canva/user";

                    // Initialize an OAuth client
                    const oauth = auth.initOauth({ type: 'multi_account' });

                    // Get an access token for the account
                    const account = await oauth.getAccount({ accountId: '123' });
                    const token = await account.getAccessToken();

                    if (token) {
                     // The account is authorized
                    } else {
                     // The account is not authorized
                    }
                    ```

                    **Forcefully refresh an access token**

                    ```ts
                    import { auth } from "@canva/user";

                    // Initialize an OAuth client
                    const oauth = auth.initOauth({ type: 'multi_account' });

                    // Get the account
                    const account = await oauth.getAccount({ accountId: '123' });

                    // Forcefully refresh an access token
                    const token = await account.getAccessToken({ forceRefresh: true });
                    ```
                  </Prop.Extras>
                </Prop>

                <Prop name="deauthorize" required type="function" sourceLineNumbers={[613]}>
                  Deauthorizes the account.

                  **Returns**

                  An empty `Promise` that resolves once the account is deauthorized.

                  `Promise<void>`

                  <Prop.Extras>
                    **Example: Deauthorize an authorized account**

                    ```ts
                    import { auth } from "@canva/user";

                    // Initialize an OAuth client
                    const oauth = auth.initOauth({ type: 'multi_account' });

                    // Get the account
                    const account = await oauth.getAccount({ accountId: '123' });

                    // Deauthorize the account
                    await account.deauthorize();
                    ```
                  </Prop.Extras>
                </Prop>

                <Prop name="principal" type="string" sourceLineNumbers={[515]}>
                  The principal of the account (e.g., email, username).
                </Prop>

                <Prop name="avatarUrl" type="string" sourceLineNumbers={[523]}>
                  The avatar URL of the account.
                </Prop>

                <Prop name="subdomain" type="string" sourceLineNumbers={[531]}>
                  The subdomain associated with the OAuth account.
                </Prop>
              </Prop.List>
            </PillAccordion>
          </Prop>
        </Prop.List>
      </Prop>
    </Prop.List>
  </Tab>
</Tabs>

## Rate limit

This method has a rate limit of 10 requests every 10 seconds.