| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <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> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates an Identity Aware Proxy (IAP) OAuth client. The client is owned</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes an Identity Aware Proxy (IAP) OAuth client. Useful for removing</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieves an Identity Aware Proxy (IAP) OAuth client.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists the existing clients for the brand.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#resetSecret">resetSecret(name, body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| <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. |
| |
| Args: |
| 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) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Contains the data that describes an Identity Aware Proxy owned client. |
| "displayName": "A String", # Human-friendly name given to the OAuth client. |
| "name": "A String", # Output only. Unique identifier of the OAuth client. |
| "secret": "A String", # Output only. Client secret of the OAuth client. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains the data that describes an Identity Aware Proxy owned client. |
| "displayName": "A String", # Human-friendly name given to the OAuth client. |
| "name": "A String", # Output only. Unique identifier of the OAuth client. |
| "secret": "A String", # Output only. Client secret of the OAuth client. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <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. |
| |
| Args: |
| 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) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # 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 `{}`. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Retrieves an Identity Aware Proxy (IAP) OAuth client. |
| Requires that the client is owned by IAP. |
| |
| Args: |
| 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) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains the data that describes an Identity Aware Proxy owned client. |
| "displayName": "A String", # Human-friendly name given to the OAuth client. |
| "name": "A String", # Output only. Unique identifier of the OAuth client. |
| "secret": "A String", # Output only. Client secret of the OAuth client. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageToken=None, pageSize=None, x__xgafv=None)</code> |
| <pre>Lists the existing clients for the brand. |
| |
| Args: |
| parent: string, Required. Full brand path. |
| In the following format: projects/{project_number/id}/brands/{brand}. (required) |
| 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. |
| 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. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for ListIdentityAwareProxyClients. |
| "identityAwareProxyClients": [ # Clients existing in the brand. |
| { # Contains the data that describes an Identity Aware Proxy owned client. |
| "displayName": "A String", # Human-friendly name given to the OAuth client. |
| "name": "A String", # Output only. Unique identifier of the OAuth client. |
| "secret": "A String", # Output only. Client secret of the OAuth client. |
| }, |
| ], |
| "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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="resetSecret">resetSecret(name, body=None, x__xgafv=None)</code> |
| <pre>Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful if the |
| secret was compromised. Requires that the client is owned by IAP. |
| |
| Args: |
| 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) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # The request sent to ResetIdentityAwareProxyClientSecret. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains the data that describes an Identity Aware Proxy owned client. |
| "displayName": "A String", # Human-friendly name given to the OAuth client. |
| "name": "A String", # Output only. Unique identifier of the OAuth client. |
| "secret": "A String", # Output only. Client secret of the OAuth client. |
| }</pre> |
| </div> |
| |
| </body></html> |
