1 | <?php
|
---|
2 | /*
|
---|
3 | * Copyright 2014 Google Inc.
|
---|
4 | *
|
---|
5 | * Licensed under the Apache License, Version 2.0 (the "License"); you may not
|
---|
6 | * use this file except in compliance with the License. You may obtain a copy of
|
---|
7 | * the License at
|
---|
8 | *
|
---|
9 | * http://www.apache.org/licenses/LICENSE-2.0
|
---|
10 | *
|
---|
11 | * Unless required by applicable law or agreed to in writing, software
|
---|
12 | * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
---|
13 | * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
---|
14 | * License for the specific language governing permissions and limitations under
|
---|
15 | * the License.
|
---|
16 | */
|
---|
17 |
|
---|
18 | namespace Google\Service\CloudIAP\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\CloudIAP\IapEmpty;
|
---|
21 | use Google\Service\CloudIAP\IdentityAwareProxyClient;
|
---|
22 | use Google\Service\CloudIAP\ListIdentityAwareProxyClientsResponse;
|
---|
23 | use Google\Service\CloudIAP\ResetIdentityAwareProxyClientSecretRequest;
|
---|
24 |
|
---|
25 | /**
|
---|
26 | * The "identityAwareProxyClients" collection of methods.
|
---|
27 | * Typical usage is:
|
---|
28 | * <code>
|
---|
29 | * $iapService = new Google\Service\CloudIAP(...);
|
---|
30 | * $identityAwareProxyClients = $iapService->projects_brands_identityAwareProxyClients;
|
---|
31 | * </code>
|
---|
32 | */
|
---|
33 | class ProjectsBrandsIdentityAwareProxyClients extends \Google\Service\Resource
|
---|
34 | {
|
---|
35 | /**
|
---|
36 | * Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by
|
---|
37 | * IAP. Requires that the brand for the project exists and that it is set for
|
---|
38 | * internal-only use. (identityAwareProxyClients.create)
|
---|
39 | *
|
---|
40 | * @param string $parent Required. Path to create the client in. In the
|
---|
41 | * following format: projects/{project_number/id}/brands/{brand}. The project
|
---|
42 | * must belong to a G Suite account.
|
---|
43 | * @param IdentityAwareProxyClient $postBody
|
---|
44 | * @param array $optParams Optional parameters.
|
---|
45 | * @return IdentityAwareProxyClient
|
---|
46 | * @throws \Google\Service\Exception
|
---|
47 | */
|
---|
48 | public function create($parent, IdentityAwareProxyClient $postBody, $optParams = [])
|
---|
49 | {
|
---|
50 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
51 | $params = array_merge($params, $optParams);
|
---|
52 | return $this->call('create', [$params], IdentityAwareProxyClient::class);
|
---|
53 | }
|
---|
54 | /**
|
---|
55 | * Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing
|
---|
56 | * obsolete clients, managing the number of clients in a given project, and
|
---|
57 | * cleaning up after tests. Requires that the client is owned by IAP.
|
---|
58 | * (identityAwareProxyClients.delete)
|
---|
59 | *
|
---|
60 | * @param string $name Required. Name of the Identity Aware Proxy client to be
|
---|
61 | * deleted. In the following format: projects/{project_number/id}/brands/{brand}
|
---|
62 | * /identityAwareProxyClients/{client_id}.
|
---|
63 | * @param array $optParams Optional parameters.
|
---|
64 | * @return IapEmpty
|
---|
65 | * @throws \Google\Service\Exception
|
---|
66 | */
|
---|
67 | public function delete($name, $optParams = [])
|
---|
68 | {
|
---|
69 | $params = ['name' => $name];
|
---|
70 | $params = array_merge($params, $optParams);
|
---|
71 | return $this->call('delete', [$params], IapEmpty::class);
|
---|
72 | }
|
---|
73 | /**
|
---|
74 | * Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the
|
---|
75 | * client is owned by IAP. (identityAwareProxyClients.get)
|
---|
76 | *
|
---|
77 | * @param string $name Required. Name of the Identity Aware Proxy client to be
|
---|
78 | * fetched. In the following format: projects/{project_number/id}/brands/{brand}
|
---|
79 | * /identityAwareProxyClients/{client_id}.
|
---|
80 | * @param array $optParams Optional parameters.
|
---|
81 | * @return IdentityAwareProxyClient
|
---|
82 | * @throws \Google\Service\Exception
|
---|
83 | */
|
---|
84 | public function get($name, $optParams = [])
|
---|
85 | {
|
---|
86 | $params = ['name' => $name];
|
---|
87 | $params = array_merge($params, $optParams);
|
---|
88 | return $this->call('get', [$params], IdentityAwareProxyClient::class);
|
---|
89 | }
|
---|
90 | /**
|
---|
91 | * Lists the existing clients for the brand.
|
---|
92 | * (identityAwareProxyClients.listProjectsBrandsIdentityAwareProxyClients)
|
---|
93 | *
|
---|
94 | * @param string $parent Required. Full brand path. In the following format:
|
---|
95 | * projects/{project_number/id}/brands/{brand}.
|
---|
96 | * @param array $optParams Optional parameters.
|
---|
97 | *
|
---|
98 | * @opt_param int pageSize The maximum number of clients to return. The service
|
---|
99 | * may return fewer than this value. If unspecified, at most 100 clients will be
|
---|
100 | * returned. The maximum value is 1000; values above 1000 will be coerced to
|
---|
101 | * 1000.
|
---|
102 | * @opt_param string pageToken A page token, received from a previous
|
---|
103 | * `ListIdentityAwareProxyClients` call. Provide this to retrieve the subsequent
|
---|
104 | * page. When paginating, all other parameters provided to
|
---|
105 | * `ListIdentityAwareProxyClients` must match the call that provided the page
|
---|
106 | * token.
|
---|
107 | * @return ListIdentityAwareProxyClientsResponse
|
---|
108 | * @throws \Google\Service\Exception
|
---|
109 | */
|
---|
110 | public function listProjectsBrandsIdentityAwareProxyClients($parent, $optParams = [])
|
---|
111 | {
|
---|
112 | $params = ['parent' => $parent];
|
---|
113 | $params = array_merge($params, $optParams);
|
---|
114 | return $this->call('list', [$params], ListIdentityAwareProxyClientsResponse::class);
|
---|
115 | }
|
---|
116 | /**
|
---|
117 | * Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the
|
---|
118 | * secret was compromised. Requires that the client is owned by IAP.
|
---|
119 | * (identityAwareProxyClients.resetSecret)
|
---|
120 | *
|
---|
121 | * @param string $name Required. Name of the Identity Aware Proxy client to that
|
---|
122 | * will have its secret reset. In the following format: projects/{project_number
|
---|
123 | * /id}/brands/{brand}/identityAwareProxyClients/{client_id}.
|
---|
124 | * @param ResetIdentityAwareProxyClientSecretRequest $postBody
|
---|
125 | * @param array $optParams Optional parameters.
|
---|
126 | * @return IdentityAwareProxyClient
|
---|
127 | * @throws \Google\Service\Exception
|
---|
128 | */
|
---|
129 | public function resetSecret($name, ResetIdentityAwareProxyClientSecretRequest $postBody, $optParams = [])
|
---|
130 | {
|
---|
131 | $params = ['name' => $name, 'postBody' => $postBody];
|
---|
132 | $params = array_merge($params, $optParams);
|
---|
133 | return $this->call('resetSecret', [$params], IdentityAwareProxyClient::class);
|
---|
134 | }
|
---|
135 | }
|
---|
136 |
|
---|
137 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
138 | class_alias(ProjectsBrandsIdentityAwareProxyClients::class, 'Google_Service_CloudIAP_Resource_ProjectsBrandsIdentityAwareProxyClients');
|
---|