The newest version of Google Identity Toolkit has been released as Firebase Authentication. It includes upgraded client SDKs, open source UI libraries, session management and integrated email sending service for forgotten password flows.

New projects should use Firebase Authentication. To migrate an existing project from Identity Toolkit to Firebase Authentication, see the migration guide.

Relyingparty: downloadAccount

Batch download user accounts.

Request

HTTP request

POST https://www.googleapis.com/identitytoolkit/v3/relyingparty/downloadAccount

Request body

In the request body, supply data with the following structure:

{
  "nextPageToken": string,
  "maxResults": unsigned integer
}
Property name Value Description Notes
nextPageToken string The token for the next page. This should be taken from the previous response.
maxResults unsigned integer The max number of results to return in the response.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "identitytoolkit#DownloadAccountResponse",
  "users": [
    {
      "localId": string,
      "email": string,
      "emailVerified": boolean,
      "displayName": string,
      "providerUserInfo": [
        {
          "providerId": string,
          "displayName": string,
          "photoUrl": string,
          "federatedId": string
        }
      ],
      "photoUrl": string,
      "passwordHash": bytes,
      "salt": bytes,
      "version": integer,
      "passwordUpdatedAt": double
    }
  ],
  "nextPageToken": string
}
Property name Value Description Notes
kind string The fixed string "identitytoolkit#DownloadAccountResponse".
nextPageToken string The next page token. To be used in a subsequent request to return the next page of results.
users[] list The user accounts data.
users[].localId string The local ID of the user.
users[].email string The email of the user.
users[].emailVerified boolean Whether the email has been verified.
users[].displayName string The name of the user.
users[].providerUserInfo[] list The IDP of the user.
users[].providerUserInfo[].providerId string The IdP ID. For white listed IdPs it's a short domain name, e.g., google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier.
users[].providerUserInfo[].displayName string The user's display name at the IDP.
users[].providerUserInfo[].photoUrl string The user's photo url at the IDP.
users[].providerUserInfo[].federatedId string User's identifier at IDP.
users[].photoUrl string The URL of the user profile photo.
users[].passwordHash bytes The user's hashed password.
users[].salt bytes The user's password salt.
users[].version integer Version of the user's password.
users[].passwordUpdatedAt double The timestamp when the password was last updated.