Identity Toolkit API (identitytoolkit:v2)

2022-08-17

46 new methods | New API

Additions

    Methods
  • identitytoolkit.defaultSupportedIdps.list

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • HTTP Method : GET

      Path : v2/defaultSupportedIdps

      Parameters :

        pageSize

          Description : The maximum number of items to return.

          Type : integer

          Format : int32

          Location : query

        pageToken

          Description : The next_page_token value returned from a previous List request, if any.

          Location : query

          Type : string

      Flat Path : v2/defaultSupportedIdps

      Description : List all default supported Idps.

  • identitytoolkit.projects.inboundSamlConfigs.list

      Parameter Order : parent

      Parameters :

        pageToken

          Description : The next_page_token value returned from a previous List request, if any.

          Location : query

          Type : string

        parent

          Pattern : ^projects/[^/]+$

          Type : string

          Description : The parent resource name, for example, "projects/my-awesome-project".

          Location : path

          Required : Yes

        pageSize

          Location : query

          Type : integer

          Format : int32

          Description : The maximum number of items to return.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • HTTP Method : GET

      Path : v2/{+parent}/inboundSamlConfigs

      Description : List all inbound SAML configurations for an Identity Toolkit project.

      Flat Path : v2/projects/{projectsId}/inboundSamlConfigs

  • identitytoolkit.projects.inboundSamlConfigs.get

      Flat Path : v2/projects/{projectsId}/inboundSamlConfigs/{inboundSamlConfigsId}

      Parameter Order : name

      HTTP Method : GET

      Parameters :

        name

          Location : path

          Required : Yes

          Pattern : ^projects/[^/]+/inboundSamlConfigs/[^/]+$

          Type : string

          Description : The resource name of the config, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'.

      Path : v2/{+name}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Description : Retrieve an inbound SAML configuration for an Identity Toolkit project.

  • identitytoolkit.projects.inboundSamlConfigs.patch

      Parameters :

        name

          Required : Yes

          Pattern : ^projects/[^/]+/inboundSamlConfigs/[^/]+$

          Location : path

          Type : string

          Description : The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests.

        updateMask

          Location : query

          Format : google-fieldmask

          Type : string

          Description : The update mask applies to the resource. Empty update mask will result in updating nothing. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

      HTTP Method : PATCH

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Parameter Order : name

      Path : v2/{+name}

      Flat Path : v2/projects/{projectsId}/inboundSamlConfigs/{inboundSamlConfigsId}

      Description : Update an inbound SAML configuration for an Identity Toolkit project.

  • identitytoolkit.projects.inboundSamlConfigs.create

      HTTP Method : POST

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Path : v2/{+parent}/inboundSamlConfigs

      Parameters :

        inboundSamlConfigId

          Description : The id to use for this config.

          Location : query

          Type : string

        parent

          Description : The parent resource name where the config to be created, for example: "projects/my-awesome-project"

          Pattern : ^projects/[^/]+$

          Required : Yes

          Type : string

          Location : path

      Description : Create an inbound SAML configuration for an Identity Toolkit project.

      Parameter Order : parent

      Flat Path : v2/projects/{projectsId}/inboundSamlConfigs

  • identitytoolkit.projects.inboundSamlConfigs.delete

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Path : v2/{+name}

      Parameters :

        name

          Pattern : ^projects/[^/]+/inboundSamlConfigs/[^/]+$

          Required : Yes

          Type : string

          Description : The resource name of the config to be deleted, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'.

          Location : path

      Description : Delete an inbound SAML configuration for an Identity Toolkit project.

      Flat Path : v2/projects/{projectsId}/inboundSamlConfigs/{inboundSamlConfigsId}

      HTTP Method : DELETE

      Parameter Order : name

  • identitytoolkit.projects.defaultSupportedIdpConfigs.list

      Flat Path : v2/projects/{projectsId}/defaultSupportedIdpConfigs

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Parameters :

        pageToken

          Type : string

          Description : The next_page_token value returned from a previous List request, if any.

          Location : query

        pageSize

          Type : integer

          Format : int32

          Location : query

          Description : The maximum number of items to return.

        parent

          Required : Yes

          Type : string

          Location : path

          Description : The parent resource name, for example, "projects/my-awesome-project".

          Pattern : ^projects/[^/]+$

      HTTP Method : GET

      Parameter Order : parent

      Description : List all default supported Idp configurations for an Identity Toolkit project.

      Path : v2/{+parent}/defaultSupportedIdpConfigs

  • identitytoolkit.projects.defaultSupportedIdpConfigs.create

      HTTP Method : POST

      Description : Create a default supported Idp configuration for an Identity Toolkit project.

      Parameter Order : parent

      Parameters :

        idpId

          Location : query

          Description : The id of the Idp to create a config for. Call ListDefaultSupportedIdps for list of all default supported Idps.

          Type : string

        parent

          Location : path

          Type : string

          Required : Yes

          Pattern : ^projects/[^/]+$

          Description : The parent resource name where the config to be created, for example: "projects/my-awesome-project"

      Flat Path : v2/projects/{projectsId}/defaultSupportedIdpConfigs

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Path : v2/{+parent}/defaultSupportedIdpConfigs

  • identitytoolkit.projects.defaultSupportedIdpConfigs.get

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Path : v2/{+name}

      Flat Path : v2/projects/{projectsId}/defaultSupportedIdpConfigs/{defaultSupportedIdpConfigsId}

      Description : Retrieve a default supported Idp configuration for an Identity Toolkit project.

      HTTP Method : GET

      Parameter Order : name

      Parameters :

        name

          Pattern : ^projects/[^/]+/defaultSupportedIdpConfigs/[^/]+$

          Type : string

          Description : The resource name of the config, for example: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com"

          Location : path

          Required : Yes

  • identitytoolkit.projects.defaultSupportedIdpConfigs.delete

      Flat Path : v2/projects/{projectsId}/defaultSupportedIdpConfigs/{defaultSupportedIdpConfigsId}

      Parameter Order : name

      Parameters :

        name

          Pattern : ^projects/[^/]+/defaultSupportedIdpConfigs/[^/]+$

          Location : path

          Description : The resource name of the config, for example: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com"

          Required : Yes

          Type : string

      HTTP Method : DELETE

      Path : v2/{+name}

      Description : Delete a default supported Idp configuration for an Identity Toolkit project.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
  • identitytoolkit.projects.defaultSupportedIdpConfigs.patch

      Description : Update a default supported Idp configuration for an Identity Toolkit project.

      Parameters :

        updateMask

          Type : string

          Description : The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

          Location : query

          Format : google-fieldmask

        name

          Type : string

          Required : Yes

          Pattern : ^projects/[^/]+/defaultSupportedIdpConfigs/[^/]+$

          Description : The name of the DefaultSupportedIdpConfig resource, for example: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com"

          Location : path

      Path : v2/{+name}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • HTTP Method : PATCH

      Flat Path : v2/projects/{projectsId}/defaultSupportedIdpConfigs/{defaultSupportedIdpConfigsId}

      Parameter Order : name

  • identitytoolkit.projects.oauthIdpConfigs.get

      Flat Path : v2/projects/{projectsId}/oauthIdpConfigs/{oauthIdpConfigsId}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Path : v2/{+name}

      Description : Retrieve an Oidc Idp configuration for an Identity Toolkit project.

      Parameters :

        name

          Pattern : ^projects/[^/]+/oauthIdpConfigs/[^/]+$

          Required : Yes

          Type : string

          Description : The resource name of the config, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'.

          Location : path

      Parameter Order : name

      HTTP Method : GET

  • identitytoolkit.projects.oauthIdpConfigs.patch

      Path : v2/{+name}

      HTTP Method : PATCH

      Flat Path : v2/projects/{projectsId}/oauthIdpConfigs/{oauthIdpConfigsId}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Description : Update an Oidc Idp configuration for an Identity Toolkit project.

      Parameter Order : name

      Parameters :

        updateMask

          Description : The update mask applies to the resource. Empty update mask will result in updating nothing. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

          Type : string

          Format : google-fieldmask

          Location : query

        name

          Pattern : ^projects/[^/]+/oauthIdpConfigs/[^/]+$

          Description : The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.

          Location : path

          Type : string

          Required : Yes

  • identitytoolkit.projects.oauthIdpConfigs.list

      Flat Path : v2/projects/{projectsId}/oauthIdpConfigs

      Parameter Order : parent

      Description : List all Oidc Idp configurations for an Identity Toolkit project.

      HTTP Method : GET

      Parameters :

        pageToken

          Location : query

          Description : The next_page_token value returned from a previous List request, if any.

          Type : string

        parent

          Required : Yes

          Pattern : ^projects/[^/]+$

          Location : path

          Description : The parent resource name, for example, "projects/my-awesome-project".

          Type : string

        pageSize

          Description : The maximum number of items to return.

          Format : int32

          Location : query

          Type : integer

      Path : v2/{+parent}/oauthIdpConfigs

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
  • identitytoolkit.projects.oauthIdpConfigs.create

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Parameters :

        oauthIdpConfigId

          Location : query

          Description : The id to use for this config.

          Type : string

        parent

          Type : string

          Pattern : ^projects/[^/]+$

          Description : The parent resource name where the config to be created, for example: "projects/my-awesome-project"

          Location : path

          Required : Yes

      Flat Path : v2/projects/{projectsId}/oauthIdpConfigs

      Parameter Order : parent

      Description : Create an Oidc Idp configuration for an Identity Toolkit project.

      HTTP Method : POST

      Path : v2/{+parent}/oauthIdpConfigs

  • identitytoolkit.projects.oauthIdpConfigs.delete

      Description : Delete an Oidc Idp configuration for an Identity Toolkit project.

      HTTP Method : DELETE

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Flat Path : v2/projects/{projectsId}/oauthIdpConfigs/{oauthIdpConfigsId}

      Path : v2/{+name}

      Parameters :

        name

          Pattern : ^projects/[^/]+/oauthIdpConfigs/[^/]+$

          Type : string

          Required : Yes

          Location : path

          Description : The resource name of the config to be deleted, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'.

      Parameter Order : name

  • identitytoolkit.projects.tenants.inboundSamlConfigs.list

      Parameters :

        pageSize

          Format : int32

          Description : The maximum number of items to return.

          Location : query

          Type : integer

        pageToken

          Type : string

          Location : query

          Description : The next_page_token value returned from a previous List request, if any.

        parent

          Pattern : ^projects/[^/]+/tenants/[^/]+$

          Required : Yes

          Type : string

          Location : path

          Description : The parent resource name, for example, "projects/my-awesome-project".

      Description : List all inbound SAML configurations for an Identity Toolkit project.

      Path : v2/{+parent}/inboundSamlConfigs

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/inboundSamlConfigs

      HTTP Method : GET

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
  • identitytoolkit.projects.tenants.inboundSamlConfigs.create

      Parameter Order : parent

      Description : Create an inbound SAML configuration for an Identity Toolkit project.

      Path : v2/{+parent}/inboundSamlConfigs

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/inboundSamlConfigs

      HTTP Method : POST

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Parameters :

        inboundSamlConfigId

          Type : string

          Description : The id to use for this config.

          Location : query

        parent

          Location : path

          Required : Yes

          Pattern : ^projects/[^/]+/tenants/[^/]+$

          Description : The parent resource name where the config to be created, for example: "projects/my-awesome-project"

          Type : string

  • identitytoolkit.projects.tenants.inboundSamlConfigs.patch

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/inboundSamlConfigs/{inboundSamlConfigsId}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Parameters :

        updateMask

          Type : string

          Location : query

          Description : The update mask applies to the resource. Empty update mask will result in updating nothing. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

          Format : google-fieldmask

        name

          Location : path

          Type : string

          Pattern : ^projects/[^/]+/tenants/[^/]+/inboundSamlConfigs/[^/]+$

          Description : The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests.

          Required : Yes

      Parameter Order : name

      Description : Update an inbound SAML configuration for an Identity Toolkit project.

      Path : v2/{+name}

      HTTP Method : PATCH

  • identitytoolkit.projects.tenants.inboundSamlConfigs.delete

      HTTP Method : DELETE

      Path : v2/{+name}

      Parameter Order : name

      Description : Delete an inbound SAML configuration for an Identity Toolkit project.

      Parameters :

        name

          Type : string

          Description : The resource name of the config to be deleted, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'.

          Pattern : ^projects/[^/]+/tenants/[^/]+/inboundSamlConfigs/[^/]+$

          Location : path

          Required : Yes

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/inboundSamlConfigs/{inboundSamlConfigsId}

  • identitytoolkit.projects.tenants.inboundSamlConfigs.get

      Path : v2/{+name}

      Parameter Order : name

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/inboundSamlConfigs/{inboundSamlConfigsId}

      Description : Retrieve an inbound SAML configuration for an Identity Toolkit project.

      Parameters :

        name

          Location : path

          Type : string

          Description : The resource name of the config, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'.

          Required : Yes

          Pattern : ^projects/[^/]+/tenants/[^/]+/inboundSamlConfigs/[^/]+$

  • identitytoolkit.projects.tenants.defaultSupportedIdpConfigs.get

      Parameters :

        name

          Required : Yes

          Type : string

          Pattern : ^projects/[^/]+/tenants/[^/]+/defaultSupportedIdpConfigs/[^/]+$

          Location : path

          Description : The resource name of the config, for example: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com"

      HTTP Method : GET

      Path : v2/{+name}

      Description : Retrieve a default supported Idp configuration for an Identity Toolkit project.

      Parameter Order : name

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/defaultSupportedIdpConfigs/{defaultSupportedIdpConfigsId}

  • identitytoolkit.projects.tenants.defaultSupportedIdpConfigs.patch

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Description : Update a default supported Idp configuration for an Identity Toolkit project.

      Parameters :

        name

          Pattern : ^projects/[^/]+/tenants/[^/]+/defaultSupportedIdpConfigs/[^/]+$

          Type : string

          Description : The name of the DefaultSupportedIdpConfig resource, for example: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com"

          Required : Yes

          Location : path

        updateMask

          Type : string

          Location : query

          Format : google-fieldmask

          Description : The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

      Path : v2/{+name}

      HTTP Method : PATCH

      Parameter Order : name

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/defaultSupportedIdpConfigs/{defaultSupportedIdpConfigsId}

  • identitytoolkit.projects.tenants.defaultSupportedIdpConfigs.list

      Description : List all default supported Idp configurations for an Identity Toolkit project.

      Parameter Order : parent

      Path : v2/{+parent}/defaultSupportedIdpConfigs

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/defaultSupportedIdpConfigs

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Parameters :

        parent

          Location : path

          Description : The parent resource name, for example, "projects/my-awesome-project".

          Type : string

          Pattern : ^projects/[^/]+/tenants/[^/]+$

          Required : Yes

        pageToken

          Type : string

          Description : The next_page_token value returned from a previous List request, if any.

          Location : query

        pageSize

          Location : query

          Type : integer

          Description : The maximum number of items to return.

          Format : int32

  • identitytoolkit.projects.tenants.defaultSupportedIdpConfigs.delete

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/tenants/[^/]+/defaultSupportedIdpConfigs/[^/]+$

          Description : The resource name of the config, for example: "projects/my-awesome-project/defaultSupportedIdpConfigs/google.com"

          Required : Yes

          Type : string

      Path : v2/{+name}

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/defaultSupportedIdpConfigs/{defaultSupportedIdpConfigsId}

      HTTP Method : DELETE

      Description : Delete a default supported Idp configuration for an Identity Toolkit project.

      Parameter Order : name

  • identitytoolkit.projects.tenants.defaultSupportedIdpConfigs.create

      Parameter Order : parent

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/defaultSupportedIdpConfigs

      Description : Create a default supported Idp configuration for an Identity Toolkit project.

      Path : v2/{+parent}/defaultSupportedIdpConfigs

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Parameters :

        parent

          Type : string

          Location : path

          Required : Yes

          Description : The parent resource name where the config to be created, for example: "projects/my-awesome-project"

          Pattern : ^projects/[^/]+/tenants/[^/]+$

        idpId

          Description : The id of the Idp to create a config for. Call ListDefaultSupportedIdps for list of all default supported Idps.

          Type : string

          Location : query

      HTTP Method : POST

  • identitytoolkit.projects.tenants.oauthIdpConfigs.list

      Description : List all Oidc Idp configurations for an Identity Toolkit project.

      Parameters :

        pageSize

          Format : int32

          Description : The maximum number of items to return.

          Type : integer

          Location : query

        parent

          Type : string

          Required : Yes

          Location : path

          Description : The parent resource name, for example, "projects/my-awesome-project".

          Pattern : ^projects/[^/]+/tenants/[^/]+$

        pageToken

          Type : string

          Location : query

          Description : The next_page_token value returned from a previous List request, if any.

      Path : v2/{+parent}/oauthIdpConfigs

      Parameter Order : parent

      HTTP Method : GET

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/oauthIdpConfigs

  • identitytoolkit.projects.tenants.oauthIdpConfigs.create

      Parameter Order : parent

      Parameters :

        parent

          Pattern : ^projects/[^/]+/tenants/[^/]+$

          Required : Yes

          Location : path

          Description : The parent resource name where the config to be created, for example: "projects/my-awesome-project"

          Type : string

        oauthIdpConfigId

          Location : query

          Type : string

          Description : The id to use for this config.

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/oauthIdpConfigs

      Path : v2/{+parent}/oauthIdpConfigs

      HTTP Method : POST

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Description : Create an Oidc Idp configuration for an Identity Toolkit project.

  • identitytoolkit.projects.tenants.oauthIdpConfigs.get

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/oauthIdpConfigs/{oauthIdpConfigsId}

      Parameter Order : name

      Parameters :

        name

          Location : path

          Pattern : ^projects/[^/]+/tenants/[^/]+/oauthIdpConfigs/[^/]+$

          Description : The resource name of the config, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'.

          Type : string

          Required : Yes

      Path : v2/{+name}

      Description : Retrieve an Oidc Idp configuration for an Identity Toolkit project.

      HTTP Method : GET

  • identitytoolkit.projects.tenants.oauthIdpConfigs.patch

      Description : Update an Oidc Idp configuration for an Identity Toolkit project.

      Parameters :

        name

          Pattern : ^projects/[^/]+/tenants/[^/]+/oauthIdpConfigs/[^/]+$

          Type : string

          Description : The name of the OAuthIdpConfig resource, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'. Ignored during create requests.

          Required : Yes

          Location : path

        updateMask

          Format : google-fieldmask

          Location : query

          Description : The update mask applies to the resource. Empty update mask will result in updating nothing. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

          Type : string

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/oauthIdpConfigs/{oauthIdpConfigsId}

      Path : v2/{+name}

      Parameter Order : name

      HTTP Method : PATCH

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
  • identitytoolkit.projects.tenants.oauthIdpConfigs.delete

      Parameters :

        name

          Required : Yes

          Type : string

          Location : path

          Description : The resource name of the config to be deleted, for example: 'projects/my-awesome-project/oauthIdpConfigs/oauth-config-id'.

          Pattern : ^projects/[^/]+/tenants/[^/]+/oauthIdpConfigs/[^/]+$

      HTTP Method : DELETE

      Parameter Order : name

      Description : Delete an Oidc Idp configuration for an Identity Toolkit project.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Path : v2/{+name}

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}/oauthIdpConfigs/{oauthIdpConfigsId}

  • identitytoolkit.projects.tenants.get

      Path : v2/{+name}

      Parameter Order : name

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}

      Parameters :

        name

          Type : string

          Description : Resource name of the tenant to retrieve.

          Pattern : ^projects/[^/]+/tenants/[^/]+$

          Location : path

          Required : Yes

      Description : Get a tenant. Requires read permission on the Tenant resource.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • HTTP Method : GET

  • identitytoolkit.projects.tenants.testIamPermissions

      Path : v2/{+resource}:testIamPermissions

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}:testIamPermissions

      Parameter Order : resource

      HTTP Method : POST

      Parameters :

        resource

          Description : REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Location : path

          Type : string

          Pattern : ^projects/[^/]+/tenants/[^/]+$

          Required : Yes

      Description : Returns the caller's permissions on a resource. An error is returned if the resource does not exist. A caller is not required to have Google IAM permission to make this request.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
  • identitytoolkit.projects.tenants.delete

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Parameters :

        name

          Pattern : ^projects/[^/]+/tenants/[^/]+$

          Required : Yes

          Type : string

          Description : Resource name of the tenant to delete.

          Location : path

      Description : Delete a tenant. Requires write permission on the Agent project.

      Parameter Order : name

      HTTP Method : DELETE

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}

      Path : v2/{+name}

  • identitytoolkit.projects.tenants.setIamPolicy

      Description : Sets the access control policy for a resource. If the policy exists, it is replaced. Caller must have the right Google IAM permission on the resource.

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}:setIamPolicy

      Parameter Order : resource

      Parameters :

        resource

          Pattern : ^projects/[^/]+/tenants/[^/]+$

          Description : REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

          Required : Yes

          Location : path

          Type : string

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • HTTP Method : POST

      Path : v2/{+resource}:setIamPolicy

  • identitytoolkit.projects.tenants.list

      Flat Path : v2/projects/{projectsId}/tenants

      Parameter Order : parent

      Description : List tenants under the given agent project. Requires read permission on the Agent project.

      Path : v2/{+parent}/tenants

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • HTTP Method : GET

      Parameters :

        parent

          Location : path

          Description : Required. The parent resource name to list tenants for.

          Required : Yes

          Pattern : ^projects/[^/]+$

          Type : string

        pageToken

          Description : The pagination token from the response of a previous request.

          Type : string

          Location : query

        pageSize

          Location : query

          Format : int32

          Type : integer

          Description : The maximum number of results to return, capped at 1000. If not specified, the default value is 20.

  • identitytoolkit.projects.tenants.patch

      Parameters :

        name

          Required : Yes

          Type : string

          Description : Output only. Resource name of a tenant. For example: "projects/{project-id}/tenants/{tenant-id}"

          Pattern : ^projects/[^/]+/tenants/[^/]+$

          Location : path

        updateMask

          Type : string

          Description : If provided, only update fields set in the update mask. Otherwise, all settable fields will be updated. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

          Format : google-fieldmask

          Location : query

      Parameter Order : name

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}

      Description : Update a tenant. Requires write permission on the Tenant resource.

      Path : v2/{+name}

      HTTP Method : PATCH

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
  • identitytoolkit.projects.tenants.getIamPolicy

      Description : Gets the access control policy for a resource. An error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it. Caller must have the right Google IAM permission on the resource.

      Parameter Order : resource

      HTTP Method : POST

      Path : v2/{+resource}:getIamPolicy

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Parameters :

        resource

          Type : string

          Location : path

          Pattern : ^projects/[^/]+/tenants/[^/]+$

          Required : Yes

          Description : REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.

      Flat Path : v2/projects/{projectsId}/tenants/{tenantsId}:getIamPolicy

  • identitytoolkit.projects.tenants.create

      Parameters :

        parent

          Type : string

          Pattern : ^projects/[^/]+$

          Location : path

          Description : The parent resource name where the tenant will be created. For example, "projects/project1".

          Required : Yes

      Path : v2/{+parent}/tenants

      Description : Create a tenant. Requires write permission on the Agent project.

      HTTP Method : POST

      Parameter Order : parent

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Flat Path : v2/projects/{projectsId}/tenants

  • identitytoolkit.projects.getConfig

      HTTP Method : GET

      Path : v2/{+name}

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Description : Retrieve an Identity Toolkit project configuration.

      Parameters :

        name

          Required : Yes

          Location : path

          Type : string

          Description : The resource name of the config, for example: "projects/my-awesome-project/config"

          Pattern : ^projects/[^/]+/config$

      Flat Path : v2/projects/{projectsId}/config

      Parameter Order : name

  • identitytoolkit.projects.updateConfig

      Description : Update an Identity Toolkit project configuration.

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Parameter Order : name

      Path : v2/{+name}

      HTTP Method : PATCH

      Flat Path : v2/projects/{projectsId}/config

      Parameters :

        updateMask

          Description : The update mask applies to the resource. Fields set in the config but not included in this update mask will be ignored. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask

          Location : query

          Type : string

          Format : google-fieldmask

        name

          Location : path

          Type : string

          Required : Yes

          Description : Output only. The name of the Config resource. Example: "projects/my-awesome-project/config"

          Pattern : ^projects/[^/]+/config$

  • identitytoolkit.accounts.mfaEnrollment.finalize

  • identitytoolkit.accounts.mfaEnrollment.start

      Path : v2/accounts/mfaEnrollment:start

      Scopes : https://www.googleapis.com/auth/cloud-platform

      Flat Path : v2/accounts/mfaEnrollment:start

      HTTP Method : POST

      Description : Step one of the MFA enrollment process. In SMS case, this sends an SMS verification code to the user.

  • identitytoolkit.accounts.mfaEnrollment.withdraw

      Flat Path : v2/accounts/mfaEnrollment:withdraw

      Description : Revokes one second factor from the enrolled second factors for an account.

      Scopes : https://www.googleapis.com/auth/cloud-platform

      HTTP Method : POST

      Path : v2/accounts/mfaEnrollment:withdraw

  • identitytoolkit.accounts.mfaSignIn.start

  • identitytoolkit.accounts.mfaSignIn.finalize