Firebase App Check API (firebaseappcheck:v1beta)

2023-12-08

6 new methods

Additions

    Methods
  • firebaseappcheck.projects.services.resourcePolicies.get

      Parameters :

        name

          Required : Yes

          Type : string

          Description : Required. The relative resource name of the ResourcePolicy to retrieve, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.

          Location : path

          Pattern : ^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$

      HTTP Method : GET

      Parameter Order : name

      Flat Path : v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}

      Scopes :

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

      Description : Gets the requested ResourcePolicy configuration.

  • firebaseappcheck.projects.services.resourcePolicies.list

      HTTP Method : GET

      Flat Path : v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies

      Parameters :

        pageToken

          Location : query

          Type : string

          Description : Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicys to resume listing. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListResourcePolicies must match the call that provided the page token; if they do not match, the result is undefined.

        parent

          Type : string

          Location : path

          Required : Yes

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

          Description : Required. The relative resource name of the parent project and service for which to list each associated ResourcePolicy, in the format: ``` projects/{project_number}/services/{service_name} ```

        pageSize

          Type : integer

          Format : int32

          Description : The maximum number of ResourcePolicys to return in the response. Only explicitly configured policies are returned. The server may return fewer than this at its own discretion. If no value is specified (or too large a value is specified), the server will impose its own limit.

          Location : query

      Description : Lists all ResourcePolicy configurations for the specified project and service.

      Path : v1beta/{+parent}/resourcePolicies

      Scopes :

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

  • firebaseappcheck.projects.services.resourcePolicies.patch

      HTTP Method : PATCH

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Description : Updates the specified ResourcePolicy configuration.

      Flat Path : v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}

      Path : v1beta/{+name}

      Parameters :

        updateMask

          Description : Required. A comma-separated list of names of fields in the ResourcePolicy to update. Example: `enforcement_mode`.

          Location : query

          Type : string

          Format : google-fieldmask

        name

          Description : Required. The relative name of the resource configuration object, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_policy_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS) `resource_policy_id` is a system-generated UID used as the resource ID for the policy.

          Type : string

          Pattern : ^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$

          Location : path

          Required : Yes

      Parameter Order : name

  • firebaseappcheck.projects.services.resourcePolicies.create

      Scopes :

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Flat Path : v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies

      Description : Creates the specified ResourcePolicy configuration.

      Path : v1beta/{+parent}/resourcePolicies

      Parameters :

        parent

          Required : Yes

          Description : Required. The relative resource name of the parent service in which the specified ResourcePolicy will be created, in the format: ``` projects/{project_number}/services/{service_id} ``` Note that the `service_id` element must be a supported service ID. Currently, the following service IDs are supported: * `oauth2.googleapis.com` (Google Identity for iOS)

          Type : string

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

          Location : path

      HTTP Method : POST

      Parameter Order : parent

  • firebaseappcheck.projects.services.resourcePolicies.delete

      Scopes :

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

        etag

          Description : The checksum to be validated against the current ResourcePolicy, to ensure the client has an up-to-date value before proceeding. The user can obtain this from the ResourcePolicy object that they last received. This etag is strongly validated.

          Location : query

          Type : string

        name

          Description : Required. The relative resource name of the ResourcePolicy to delete, in the format: ``` projects/{project_number}/services/{service_id}/resourcePolicies/{resource_name} ```

          Type : string

          Pattern : ^projects/[^/]+/services/[^/]+/resourcePolicies/[^/]+$

          Location : path

          Required : Yes

      Flat Path : v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies/{resourcePoliciesId}

      Description : Deletes the specified ResourcePolicy configuration.

      Path : v1beta/{+name}

      HTTP Method : DELETE

      Parameter Order : name

  • firebaseappcheck.projects.services.resourcePolicies.batchUpdate

      Path : v1beta/{+parent}/resourcePolicies:batchUpdate

      Flat Path : v1beta/projects/{projectsId}/services/{servicesId}/resourcePolicies:batchUpdate

      Scopes :

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

        parent

          Type : string

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

          Description : Required. The parent project name and the service, in the format ``` projects/{project_number}/services/{service_id} ``` The parent collection in the `name` field of any resource being updated must match this field, or the entire batch fails.

          Required : Yes

          Location : path

      Description : Atomically updates the specified ResourcePolicy configurations.

      Parameter Order : parent

      HTTP Method : POST