forked from GoogleCloudPlatform/python-docs-samples
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrestrict_api_key_android.py
More file actions
74 lines (56 loc) · 2.67 KB
/
Copy pathrestrict_api_key_android.py
File metadata and controls
74 lines (56 loc) · 2.67 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
# 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 apikeys_restrict_api_key_android]
from google.cloud import api_keys_v2
from google.cloud.api_keys_v2 import Key
def restrict_api_key_android(project_id: str, key_id: str) -> Key:
"""
Restricts an API key based on android applications.
Specifies the Android application that can use the key.
TODO(Developer): Replace the variables before running this sample.
Args:
project_id: Google Cloud project id.
key_id: ID of the key to restrict. This ID is auto-created during key creation.
This is different from the key string. To obtain the key_id,
you can also use the lookup api: client.lookup_key()
Returns:
response: Returns the updated API Key.
"""
# Create the API Keys client.
client = api_keys_v2.ApiKeysClient()
# Specify the android application's package name and SHA1 fingerprint.
allowed_application = api_keys_v2.AndroidApplication()
allowed_application.package_name = "com.google.appname"
allowed_application.sha1_fingerprint = "0873D391E987982FBBD30873D391E987982FBBD3"
# Restrict the API key usage by specifying the allowed applications.
android_key_restriction = api_keys_v2.AndroidKeyRestrictions()
android_key_restriction.allowed_applications = [allowed_application]
# Set the restriction(s).
# For more information on API key restriction, see:
# https://cloud.google.com/docs/authentication/api-keys
restrictions = api_keys_v2.Restrictions()
restrictions.android_key_restrictions = android_key_restriction
key = api_keys_v2.Key()
key.name = f"projects/{project_id}/locations/global/keys/{key_id}"
key.restrictions = restrictions
# Initialize request and set arguments.
request = api_keys_v2.UpdateKeyRequest()
request.key = key
request.update_mask = "restrictions"
# Make the request and wait for the operation to complete.
response = client.update_key(request=request).result()
print(f"Successfully updated the API key: {response.name}")
# Use response.key_string to authenticate.
return response
# [END apikeys_restrict_api_key_android]