1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="iap_v1.html">Cloud Identity-Aware Proxy API</a> . <a href="iap_v1.projects.html">projects</a> . <a href="iap_v1.projects.brands.html">brands</a> . <a href="iap_v1.projects.brands.identityAwareProxyClients.html">identityAwareProxyClients</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the existing clients for the brand.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#resetSecret">resetSecret(name, body=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP.</p> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 106 <pre>Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned by IAP. Requires that the brand for the project exists and that it is set for internal-only use. 107 108Args: 109 parent: string, Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a G Suite account. (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # Contains the data that describes an Identity Aware Proxy owned client. 114 "displayName": "A String", # Human-friendly name given to the OAuth client. 115 "name": "A String", # Output only. Unique identifier of the OAuth client. 116 "secret": "A String", # Output only. Client secret of the OAuth client. 117} 118 119 x__xgafv: string, V1 error format. 120 Allowed values 121 1 - v1 error format 122 2 - v2 error format 123 124Returns: 125 An object of the form: 126 127 { # Contains the data that describes an Identity Aware Proxy owned client. 128 "displayName": "A String", # Human-friendly name given to the OAuth client. 129 "name": "A String", # Output only. Unique identifier of the OAuth client. 130 "secret": "A String", # Output only. Client secret of the OAuth client. 131}</pre> 132</div> 133 134<div class="method"> 135 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 136 <pre>Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP. 137 138Args: 139 name: string, Required. Name of the Identity Aware Proxy client to be deleted. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. (required) 140 x__xgafv: string, V1 error format. 141 Allowed values 142 1 - v1 error format 143 2 - v2 error format 144 145Returns: 146 An object of the form: 147 148 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 149}</pre> 150</div> 151 152<div class="method"> 153 <code class="details" id="get">get(name, x__xgafv=None)</code> 154 <pre>Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP. 155 156Args: 157 name: string, Required. Name of the Identity Aware Proxy client to be fetched. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. (required) 158 x__xgafv: string, V1 error format. 159 Allowed values 160 1 - v1 error format 161 2 - v2 error format 162 163Returns: 164 An object of the form: 165 166 { # Contains the data that describes an Identity Aware Proxy owned client. 167 "displayName": "A String", # Human-friendly name given to the OAuth client. 168 "name": "A String", # Output only. Unique identifier of the OAuth client. 169 "secret": "A String", # Output only. Client secret of the OAuth client. 170}</pre> 171</div> 172 173<div class="method"> 174 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> 175 <pre>Lists the existing clients for the brand. 176 177Args: 178 parent: string, Required. Full brand path. In the following format: projects/{project_number/id}/brands/{brand}. (required) 179 pageSize: integer, The maximum number of clients to return. The service may return fewer than this value. If unspecified, at most 100 clients will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. 180 pageToken: string, A page token, received from a previous `ListIdentityAwareProxyClients` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListIdentityAwareProxyClients` must match the call that provided the page token. 181 x__xgafv: string, V1 error format. 182 Allowed values 183 1 - v1 error format 184 2 - v2 error format 185 186Returns: 187 An object of the form: 188 189 { # Response message for ListIdentityAwareProxyClients. 190 "identityAwareProxyClients": [ # Clients existing in the brand. 191 { # Contains the data that describes an Identity Aware Proxy owned client. 192 "displayName": "A String", # Human-friendly name given to the OAuth client. 193 "name": "A String", # Output only. Unique identifier of the OAuth client. 194 "secret": "A String", # Output only. Client secret of the OAuth client. 195 }, 196 ], 197 "nextPageToken": "A String", # A token, which can be send as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. 198}</pre> 199</div> 200 201<div class="method"> 202 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 203 <pre>Retrieves the next page of results. 204 205Args: 206 previous_request: The request for the previous page. (required) 207 previous_response: The response from the request for the previous page. (required) 208 209Returns: 210 A request object that you can call 'execute()' on to request the next 211 page. Returns None if there are no more items in the collection. 212 </pre> 213</div> 214 215<div class="method"> 216 <code class="details" id="resetSecret">resetSecret(name, body=None, x__xgafv=None)</code> 217 <pre>Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the secret was compromised. Requires that the client is owned by IAP. 218 219Args: 220 name: string, Required. Name of the Identity Aware Proxy client to that will have its secret reset. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}. (required) 221 body: object, The request body. 222 The object takes the form of: 223 224{ # The request sent to ResetIdentityAwareProxyClientSecret. 225} 226 227 x__xgafv: string, V1 error format. 228 Allowed values 229 1 - v1 error format 230 2 - v2 error format 231 232Returns: 233 An object of the form: 234 235 { # Contains the data that describes an Identity Aware Proxy owned client. 236 "displayName": "A String", # Human-friendly name given to the OAuth client. 237 "name": "A String", # Output only. Unique identifier of the OAuth client. 238 "secret": "A String", # Output only. Client secret of the OAuth client. 239}</pre> 240</div> 241 242</body></html>