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\CloudIdentity\Resource;
|
---|
19 |
|
---|
20 | use Google\Service\CloudIdentity\AddIdpCredentialRequest;
|
---|
21 | use Google\Service\CloudIdentity\IdpCredential;
|
---|
22 | use Google\Service\CloudIdentity\ListIdpCredentialsResponse;
|
---|
23 | use Google\Service\CloudIdentity\Operation;
|
---|
24 |
|
---|
25 | /**
|
---|
26 | * The "idpCredentials" collection of methods.
|
---|
27 | * Typical usage is:
|
---|
28 | * <code>
|
---|
29 | * $cloudidentityService = new Google\Service\CloudIdentity(...);
|
---|
30 | * $idpCredentials = $cloudidentityService->inboundSamlSsoProfiles_idpCredentials;
|
---|
31 | * </code>
|
---|
32 | */
|
---|
33 | class InboundSamlSsoProfilesIdpCredentials extends \Google\Service\Resource
|
---|
34 | {
|
---|
35 | /**
|
---|
36 | * Adds an IdpCredential. Up to 2 credentials are allowed. When the target
|
---|
37 | * customer has enabled [Multi-party approval for sensitive
|
---|
38 | * actions](https://support.google.com/a/answer/13790448), the `Operation` in
|
---|
39 | * the response will have `"done": false`, it will not have a response, and the
|
---|
40 | * metadata will have `"state": "awaiting-multi-party-approval"`.
|
---|
41 | * (idpCredentials.add)
|
---|
42 | *
|
---|
43 | * @param string $parent Required. The InboundSamlSsoProfile that owns the
|
---|
44 | * IdpCredential. Format: `inboundSamlSsoProfiles/{sso_profile_id}`
|
---|
45 | * @param AddIdpCredentialRequest $postBody
|
---|
46 | * @param array $optParams Optional parameters.
|
---|
47 | * @return Operation
|
---|
48 | * @throws \Google\Service\Exception
|
---|
49 | */
|
---|
50 | public function add($parent, AddIdpCredentialRequest $postBody, $optParams = [])
|
---|
51 | {
|
---|
52 | $params = ['parent' => $parent, 'postBody' => $postBody];
|
---|
53 | $params = array_merge($params, $optParams);
|
---|
54 | return $this->call('add', [$params], Operation::class);
|
---|
55 | }
|
---|
56 | /**
|
---|
57 | * Deletes an IdpCredential. (idpCredentials.delete)
|
---|
58 | *
|
---|
59 | * @param string $name Required. The [resource
|
---|
60 | * name](https://cloud.google.com/apis/design/resource_names) of the
|
---|
61 | * IdpCredential to delete. Format:
|
---|
62 | * `inboundSamlSsoProfiles/{sso_profile_id}/idpCredentials/{idp_credential_id}`
|
---|
63 | * @param array $optParams Optional parameters.
|
---|
64 | * @return Operation
|
---|
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], Operation::class);
|
---|
72 | }
|
---|
73 | /**
|
---|
74 | * Gets an IdpCredential. (idpCredentials.get)
|
---|
75 | *
|
---|
76 | * @param string $name Required. The [resource
|
---|
77 | * name](https://cloud.google.com/apis/design/resource_names) of the
|
---|
78 | * IdpCredential to retrieve. Format:
|
---|
79 | * `inboundSamlSsoProfiles/{sso_profile_id}/idpCredentials/{idp_credential_id}`
|
---|
80 | * @param array $optParams Optional parameters.
|
---|
81 | * @return IdpCredential
|
---|
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], IdpCredential::class);
|
---|
89 | }
|
---|
90 | /**
|
---|
91 | * Returns a list of IdpCredentials in an InboundSamlSsoProfile.
|
---|
92 | * (idpCredentials.listInboundSamlSsoProfilesIdpCredentials)
|
---|
93 | *
|
---|
94 | * @param string $parent Required. The parent, which owns this collection of
|
---|
95 | * `IdpCredential`s. Format: `inboundSamlSsoProfiles/{sso_profile_id}`
|
---|
96 | * @param array $optParams Optional parameters.
|
---|
97 | *
|
---|
98 | * @opt_param int pageSize The maximum number of `IdpCredential`s to return. The
|
---|
99 | * service may return fewer than this value.
|
---|
100 | * @opt_param string pageToken A page token, received from a previous
|
---|
101 | * `ListIdpCredentials` call. Provide this to retrieve the subsequent page. When
|
---|
102 | * paginating, all other parameters provided to `ListIdpCredentials` must match
|
---|
103 | * the call that provided the page token.
|
---|
104 | * @return ListIdpCredentialsResponse
|
---|
105 | * @throws \Google\Service\Exception
|
---|
106 | */
|
---|
107 | public function listInboundSamlSsoProfilesIdpCredentials($parent, $optParams = [])
|
---|
108 | {
|
---|
109 | $params = ['parent' => $parent];
|
---|
110 | $params = array_merge($params, $optParams);
|
---|
111 | return $this->call('list', [$params], ListIdpCredentialsResponse::class);
|
---|
112 | }
|
---|
113 | }
|
---|
114 |
|
---|
115 | // Adding a class alias for backwards compatibility with the previous class name.
|
---|
116 | class_alias(InboundSamlSsoProfilesIdpCredentials::class, 'Google_Service_CloudIdentity_Resource_InboundSamlSsoProfilesIdpCredentials');
|
---|