feat: rename service account sample

Author: BigBlackWolf

iam/cloud-client/snippets/service_account_rename.py

@@ -0,0 +1,62 @@
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http:#www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START iam_rename_service_account]
+from google.cloud import iam_admin_v1
+from google.cloud.iam_admin_v1 import types
+
+
+def rename_service_account(project_id: str, account: str, new_name: str) -> types.ServiceAccount:
+    """
+    Renames service account display name.
+
+    project_id: ID or number of the Google Cloud project you want to use.
+    account: ID or email which is unique identifier of the service account.
+    new_name: New display name of the service account.
+    """
+
+    iam_admin_client = iam_admin_v1.IAMClient()
+
+    get_request = types.GetServiceAccountRequest()
+    get_request.name = f"projects/{project_id}/serviceAccounts/{account}"
+    service_account = iam_admin_client.get_service_account(request=get_request)
+
+    service_account.display_name = new_name
+
+    request = types.PatchServiceAccountRequest()
+    request.service_account = service_account
+    # You can patch only the `display_name` and `description` fields. You must use
+    # the `update_mask` field to specify which of these fields you want to patch.
+    # To successfully set update mask you need to transform snake_case field to camelCase.
+    # e.g. `display_name` will become `displayName`
+    request.update_mask = "displayName"
+
+    updated_account = iam_admin_client.patch_service_account(request=request)
+    return updated_account
+
+# [END iam_rename_service_account]
+
+
+if __name__ == "__main__":
+    # To run the sample you would need
+    # iam.serviceAccounts.update permission (roles/iam.serviceAccountAdmin)
+
+    # Your Google Cloud project ID.
+    project_id = "your-google-cloud-project-id"
+    # Existing service account name within the project specified above.
+    account_name = "test-service-account"
+    account_id = f"{account_name}@{project_id}.iam.gserviceaccount.com"
+    new_name = "New Name"
+
+    rename_service_account(project_id, account_id, new_name)

iam/cloud-client/snippets/service_account_set_policy.py

@@ -14,7 +14,7 @@
 
 # This file contains code samples that demonstrate how to set policy for service account.
 
-# [START iam_serivce_account_set_policy]
+# [START iam_service_account_set_policy]
 from google.cloud import iam_admin_v1
 from google.iam.v1 import iam_policy_pb2, policy_pb2
 
@@ -43,7 +43,7 @@ def set_policy(project_id: str, account: str, policy: policy_pb2.Policy) -> poli
     policy = iam_client.set_iam_policy(request)
     return policy
 
-# [END iam_serivce_account_set_policy]
+# [END iam_service_account_set_policy]
 
 
 if __name__ == "__main__":

iam/cloud-client/snippets/test_service_account.py

@@ -24,6 +24,7 @@
 from snippets.enable_service_account import enable_service_account
 from snippets.list_service_accounts import get_service_account, list_service_accounts
 from snippets.service_account_get_policy import get_policy
+from snippets.service_account_rename import rename_service_account
 from snippets.service_account_set_policy import set_policy
 
 PROJECT = google.auth.default()[1]
@@ -89,3 +90,9 @@ def test_service_account_set_policy(service_account: str) -> None:
             break
     assert binding_found
     assert new_policy.etag != policy.etag
+
+
+def test_service_account_rename(service_account: str) -> None:
+    new_name = "New Name"
+    account = rename_service_account(PROJECT, service_account, new_name)
+    assert account.display_name == new_name