Identity and Access Management (IAM) API (iam:v1)

2024-04-18

12 new methods

Additions

    Methods
  • iam.projects.locations.oauthClients.list

      Path: v1/{+parent}/oauthClients

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent to list oauth clients for.

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

          Location: path

          Required: Yes

          Type: string

        pageSize

          Description: Optional. The maximum number of oauth clients to return. If unspecified, at most 50 oauth clients will be returned. The maximum value is 100; values above 100 are truncated to 100.

          Location: query

          Type: integer

          Format: int32

        pageToken

          Description: Optional. A page token, received from a previous `ListOauthClients` call. Provide this to retrieve the subsequent page.

          Location: query

          Type: string

        showDeleted

          Description: Optional. Whether to return soft-deleted oauth clients.

          Location: query

          Type: boolean

      Parameter Order: parent

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

      Description: Lists all non-deleted OauthClientss in a project. If `show_deleted` is set to `true`, then deleted oauth clients are also listed.

  • iam.projects.locations.oauthClients.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the oauth client to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`.

          Pattern: ^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets an individual OauthClient.

  • iam.projects.locations.oauthClients.create

      Path: v1/{+parent}/oauthClients

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The parent resource to create the oauth client in. The only supported location is `global`.

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

          Location: path

          Required: Yes

          Type: string

        oauthClientId

          Description: Required. The ID to use for the oauth client, which becomes the final component of the resource name. This value should be a string of 6 to 63 lowercase letters, digits, or hyphens. It must start with a letter, and cannot have a trailing hyphen. The prefix `gcp-` is reserved for use by Google, and may not be specified.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Creates a new OauthClient. You cannot reuse the name of a deleted oauth client until 30 days after deletion.

  • iam.projects.locations.oauthClients.patch

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}

      HTTP Method: PATCH

      Parameters:

        name

          Description: Immutable. The resource name of the oauth client. Format:`projects/{project}/locations/{location}/oauthClients/{oauth_client}`.

          Pattern: ^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. The list of fields to update.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

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

      Description: Updates an existing OauthClient.

  • iam.projects.locations.oauthClients.delete

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The name of the oauth client to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`.

          Pattern: ^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Deletes a OauthClient. You cannot use a deleted oauth client. However, deletion does not revoke access tokens that have already been issued; they continue to grant access. Deletion does revoke refresh tokens that have already been issued; They cannot be used to renew an access token. If the oauth client is undeleted, and the refresh tokens are not expired, they are valid for token exchange again. You can undelete an oauth client for 30 days. After 30 days, deletion is permanent. You cannot update deleted oauth clients. However, you can view and list them.

  • iam.projects.locations.oauthClients.undelete

      Path: v1/{+name}:undelete

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}:undelete

      HTTP Method: POST

      Parameters:

        name

          Description: Required. The name of the oauth client to undelete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}`.

          Pattern: ^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Undeletes a OauthClient, as long as it was deleted fewer than 30 days ago.

  • iam.projects.locations.oauthClients.credentials.list

      Path: v1/{+parent}/credentials

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}/credentials

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. The parent to list oauth client credentials for.

          Pattern: ^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: parent

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

      Description: Lists all OauthClientCredentialss in a OauthClient.

  • iam.projects.locations.oauthClients.credentials.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}/credentials/{credentialsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. The name of the oauth client credential to retrieve. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`.

          Pattern: ^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+/credentials/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets an individual OauthClientCredential.

  • iam.projects.locations.oauthClients.credentials.create

      Path: v1/{+parent}/credentials

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}/credentials

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The parent resource to create the oauth client Credential in.

          Pattern: ^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+$

          Location: path

          Required: Yes

          Type: string

        oauthClientCredentialId

          Description: Required. The ID to use for the oauth client credential, which becomes the final component of the resource name. This value should be 4-32 characters, and may contain the characters [a-z0-9-]. The prefix `gcp-` is reserved for use by Google, and may not be specified.

          Location: query

          Type: string

      Parameter Order: parent

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

      Description: Creates a new OauthClientCredential.

  • iam.projects.locations.oauthClients.credentials.patch

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}/credentials/{credentialsId}

      HTTP Method: PATCH

      Parameters:

        name

          Description: Immutable. The resource name of the oauth client credential. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`

          Pattern: ^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+/credentials/[^/]+$

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Required. The list of fields to update.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: name

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

      Description: Updates an existing OauthClientCredential.

  • iam.projects.locations.oauthClients.credentials.delete

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/oauthClients/{oauthClientsId}/credentials/{credentialsId}

      HTTP Method: DELETE

      Parameters:

        name

          Description: Required. The name of the oauth client credential to delete. Format: `projects/{project}/locations/{location}/oauthClients/{oauth_client}/credentials/{credential}`.

          Pattern: ^projects/[^/]+/locations/[^/]+/oauthClients/[^/]+/credentials/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Deletes a OauthClientCredential. Before deleting an oauth client credential, it should first be disabled.

  • iam.projects.serviceAccounts.keys.patch

      Path: v1/{+name}:patch

      Flat Path: v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:patch

      HTTP Method: POST

      Parameters:

        name

          Description: The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.

          Pattern: ^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Patches a ServiceAccountKey.