Firebase App Check API (firebaseappcheck:v1)

2024-07-12

6 new methods

Additions

    Methods
  • firebaseappcheck.projects.services.resourcePolicies.list

      Scopes:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/firebase
    • Description: Lists all ResourcePolicy configurations for the specified project and service.

      Parameters:

        pageSize

          Location: query

          Description: The maximum number of ResourcePolicy objects to return in the response. 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.

          Type: integer

          Format: int32

        pageToken

          Description: Token returned from a previous call to ListResourcePolicies indicating where in the set of ResourcePolicy objects 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.

          Type: string

          Location: query

        parent

          Location: path

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

          Required: Yes

          Description: Required. The relative resource name of the parent Service for which to list each associated ResourcePolicy, 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

        filter

          Type: string

          Description: Optional. Filters the results by the specified rule. For the exact syntax of this field, please consult the [AIP-160](https://google.aip.dev/160) standard. Currently, since the only fields in the ResourcePolicy resource are the scalar fields `enforcement_mode` and `target_resource`, this method does not support the traversal operator (`.`) or the has operator (`:`). Here are some examples of valid filters: * `enforcement_mode = ENFORCED` * `target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"` * `enforcement_mode = ENFORCED AND target_resource = "//oauth2.googleapis.com/projects/12345/oauthClients/"`

          Location: query

      Parameter Order: parent

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

      HTTP Method: GET

      Path: v1/{+parent}/resourcePolicies

  • firebaseappcheck.projects.services.resourcePolicies.create

      Parameters:

        parent

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

          Location: path

          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)

          Required: Yes

          Type: string

      Parameter Order: parent

      HTTP Method: POST

      Scopes:

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

      Description: Creates the specified ResourcePolicy configuration.

      Path: v1/{+parent}/resourcePolicies

  • firebaseappcheck.projects.services.resourcePolicies.patch

      Path: v1/{+name}

      Parameters:

        updateMask

          Format: google-fieldmask

          Type: string

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

          Location: query

        name

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

          Type: string

          Description: Required. Identifier. The relative name of the resource policy 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.

          Location: path

          Required: Yes

      Description: Updates the specified ResourcePolicy configuration.

      Parameter Order: name

      Scopes:

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

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

  • firebaseappcheck.projects.services.resourcePolicies.batchUpdate

      HTTP Method: POST

      Scopes:

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

        parent

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

          Description: Required. The parent service name, 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

          Type: string

          Location: path

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

      Description: Atomically updates the specified ResourcePolicy configurations.

      Parameter Order: parent

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

  • firebaseappcheck.projects.services.resourcePolicies.get

      Path: v1/{+name}

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

      Description: Gets the requested ResourcePolicy configuration.

      Parameters:

        name

          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)

          Required: Yes

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

          Location: path

          Type: string

      Parameter Order: name

      Scopes:

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

  • firebaseappcheck.projects.services.resourcePolicies.delete

      Scopes:

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

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

      Parameters:

        etag

          Location: query

          Description: The checksum to be validated against the current ResourcePolicy, to ensure the client has an up-to-date value before proceeding. This checksum is computed by the server based on the values of fields in the ResourcePolicy object, and can be obtained from the ResourcePolicy object received from the last CreateResourcePolicy, GetResourcePolicy, ListResourcePolicies, UpdateResourcePolicy, or BatchUpdateResourcePolicies call. This etag is strongly validated as defined by RFC 7232.

          Type: string

        name

          Location: path

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

          Type: string

          Required: Yes

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

      Path: v1/{+name}

      HTTP Method: DELETE

      Description: Deletes the specified ResourcePolicy configuration.