npm package: @maxim_mazurok/gapi.client.identitytoolkit-v3
Description: TypeScript typings for Google Identity Toolkit API v3
Author: Maxim Mazurok
Latest version: 0.3.20180723

# TypeScript typings for Google Identity Toolkit API v3

Help the third party sites to implement federated login.
For detailed description please check [documentation](https://developers.google.com/identity-toolkit/v3/).

## Installing

Install typings for Google Identity Toolkit API:

```
npm install @types/gapi.client.identitytoolkit-v3 --save-dev
```

## Usage

You need to initialize Google API client in your code:

```typescript
gapi.load('client', () => {
  // now we can use gapi.client
  // ...
});
```

Then load api client wrapper:

```typescript
gapi.client.load(
  'https://identitytoolkit.googleapis.com/$discovery/rest?version=v3',
  () => {
    // now we can use:
    // gapi.client.identitytoolkit
  },
);
```

```typescript
// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
gapi.client.load('identitytoolkit', 'v3', () => {
  // now we can use:
  // gapi.client.identitytoolkit
});
```

Don't forget to authenticate your client before sending any request to resources:

```typescript
// declare client_id registered in Google Developers Console
var client_id = '',
  scope = [
    // View and manage your data across Google Cloud Platform services
    'https://www.googleapis.com/auth/cloud-platform',

    // View and administer all your Firebase data and settings
    'https://www.googleapis.com/auth/firebase',
  ],
  immediate = true;
// ...

gapi.auth.authorize(
  {client_id: client_id, scope: scope, immediate: immediate},
  authResult => {
    if (authResult && !authResult.error) {
      /* handle successful authorization */
    } else {
      /* handle authorization error */
    }
  },
);
```

After that you can use Google Identity Toolkit API resources: <!-- TODO: make this work for multiple namespaces -->

```typescript
/*
Creates the URI used by the IdP to authenticate the user.
*/
await gapi.client.identitytoolkit.relyingparty.createAuthUri({});

/*
Delete user account.
*/
await gapi.client.identitytoolkit.relyingparty.deleteAccount({});

/*
Batch download user accounts.
*/
await gapi.client.identitytoolkit.relyingparty.downloadAccount({});

/*
Reset password for a user.
*/
await gapi.client.identitytoolkit.relyingparty.emailLinkSignin({});

/*
Returns the account info.
*/
await gapi.client.identitytoolkit.relyingparty.getAccountInfo({});

/*
Get a code for user action confirmation.
*/
await gapi.client.identitytoolkit.relyingparty.getOobConfirmationCode({});

/*
Get project configuration.
*/
await gapi.client.identitytoolkit.relyingparty.getProjectConfig({});

/*
Get token signing public key.
*/
await gapi.client.identitytoolkit.relyingparty.getPublicKeys({});

/*
Get recaptcha secure param.
*/
await gapi.client.identitytoolkit.relyingparty.getRecaptchaParam({});

/*
Reset password for a user.
*/
await gapi.client.identitytoolkit.relyingparty.resetPassword({});

/*
Send SMS verification code.
*/
await gapi.client.identitytoolkit.relyingparty.sendVerificationCode({});

/*
Set account info for a user.
*/
await gapi.client.identitytoolkit.relyingparty.setAccountInfo({});

/*
Set project configuration.
*/
await gapi.client.identitytoolkit.relyingparty.setProjectConfig({});

/*
Sign out user.
*/
await gapi.client.identitytoolkit.relyingparty.signOutUser({});

/*
Signup new user.
*/
await gapi.client.identitytoolkit.relyingparty.signupNewUser({});

/*
Batch upload existing user accounts.
*/
await gapi.client.identitytoolkit.relyingparty.uploadAccount({});

/*
Verifies the assertion returned by the IdP.
*/
await gapi.client.identitytoolkit.relyingparty.verifyAssertion({});

/*
Verifies the developer asserted ID token.
*/
await gapi.client.identitytoolkit.relyingparty.verifyCustomToken({});

/*
Verifies the user entered password.
*/
await gapi.client.identitytoolkit.relyingparty.verifyPassword({});

/*
Verifies ownership of a phone number and creates/updates the user account accordingly.
*/
await gapi.client.identitytoolkit.relyingparty.verifyPhoneNumber({});
```

For provenance information see [Provenance section on NPM](https://www.npmjs.com/package/@maxim_mazurok/gapi.client.identitytoolkit-v3#Provenance:~:text=none-,Provenance,-Built%20and%20signed)