| <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="identitytoolkit_v2.html">Identity Toolkit API</a> . <a href="identitytoolkit_v2.projects.html">projects</a> . <a href="identitytoolkit_v2.projects.inboundSamlConfigs.html">inboundSamlConfigs</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, inboundSamlConfigId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create an inbound SAML configuration for an Identity Toolkit project.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete an inbound SAML configuration for an Identity Toolkit project.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Retrieve an inbound SAML configuration for an Identity Toolkit project.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List all inbound SAML configurations for an Identity Toolkit project.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update an inbound SAML configuration for an Identity Toolkit project.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, inboundSamlConfigId=None, x__xgafv=None)</code> |
| <pre>Create an inbound SAML configuration for an Identity Toolkit project. |
| |
| Args: |
| parent: string, The parent resource name where the config to be created, for example: "projects/my-awesome-project" (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A pair of SAML RP-IDP configurations when the project acts as the relying party. |
| "displayName": "A String", # The config's display name set by developers. |
| "enabled": True or False, # True if allows the user to sign in with the provider. |
| "idpConfig": { # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. |
| "idpCertificates": [ # IDP's public keys for verifying signature in the assertions. |
| { # The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. |
| "x509Certificate": "A String", # The x509 certificate |
| }, |
| ], |
| "idpEntityId": "A String", # Unique identifier for all SAML entities. |
| "signRequest": True or False, # Indicates if outbounding SAMLRequest should be signed. |
| "ssoUrl": "A String", # URL to send Authentication request to. |
| }, |
| "name": "A String", # The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests. |
| "spConfig": { # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. |
| "callbackUri": "A String", # Callback URI where responses from IDP are handled. |
| "spCertificates": [ # Output only. Public certificates generated by the server to verify the signature in SAMLRequest in the SP-initiated flow. |
| { # The SP's certificate data for IDP to verify the SAMLRequest generated by the SP. |
| "expiresAt": "A String", # Timestamp of the cert expiration instance. |
| "x509Certificate": "A String", # Self-signed public certificate. |
| }, |
| ], |
| "spEntityId": "A String", # Unique identifier for all SAML entities. |
| }, |
| } |
| |
| inboundSamlConfigId: string, The id to use for this config. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A pair of SAML RP-IDP configurations when the project acts as the relying party. |
| "displayName": "A String", # The config's display name set by developers. |
| "enabled": True or False, # True if allows the user to sign in with the provider. |
| "idpConfig": { # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. |
| "idpCertificates": [ # IDP's public keys for verifying signature in the assertions. |
| { # The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. |
| "x509Certificate": "A String", # The x509 certificate |
| }, |
| ], |
| "idpEntityId": "A String", # Unique identifier for all SAML entities. |
| "signRequest": True or False, # Indicates if outbounding SAMLRequest should be signed. |
| "ssoUrl": "A String", # URL to send Authentication request to. |
| }, |
| "name": "A String", # The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests. |
| "spConfig": { # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. |
| "callbackUri": "A String", # Callback URI where responses from IDP are handled. |
| "spCertificates": [ # Output only. Public certificates generated by the server to verify the signature in SAMLRequest in the SP-initiated flow. |
| { # The SP's certificate data for IDP to verify the SAMLRequest generated by the SP. |
| "expiresAt": "A String", # Timestamp of the cert expiration instance. |
| "x509Certificate": "A String", # Self-signed public certificate. |
| }, |
| ], |
| "spEntityId": "A String", # Unique identifier for all SAML entities. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Delete an inbound SAML configuration for an Identity Toolkit project. |
| |
| Args: |
| name: string, The resource name of the config to be deleted, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-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); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Retrieve an inbound SAML configuration for an Identity Toolkit project. |
| |
| Args: |
| name: string, The resource name of the config, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-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 pair of SAML RP-IDP configurations when the project acts as the relying party. |
| "displayName": "A String", # The config's display name set by developers. |
| "enabled": True or False, # True if allows the user to sign in with the provider. |
| "idpConfig": { # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. |
| "idpCertificates": [ # IDP's public keys for verifying signature in the assertions. |
| { # The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. |
| "x509Certificate": "A String", # The x509 certificate |
| }, |
| ], |
| "idpEntityId": "A String", # Unique identifier for all SAML entities. |
| "signRequest": True or False, # Indicates if outbounding SAMLRequest should be signed. |
| "ssoUrl": "A String", # URL to send Authentication request to. |
| }, |
| "name": "A String", # The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests. |
| "spConfig": { # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. |
| "callbackUri": "A String", # Callback URI where responses from IDP are handled. |
| "spCertificates": [ # Output only. Public certificates generated by the server to verify the signature in SAMLRequest in the SP-initiated flow. |
| { # The SP's certificate data for IDP to verify the SAMLRequest generated by the SP. |
| "expiresAt": "A String", # Timestamp of the cert expiration instance. |
| "x509Certificate": "A String", # Self-signed public certificate. |
| }, |
| ], |
| "spEntityId": "A String", # Unique identifier for all SAML entities. |
| }, |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>List all inbound SAML configurations for an Identity Toolkit project. |
| |
| Args: |
| parent: string, The parent resource name, for example, "projects/my-awesome-project". (required) |
| pageSize: integer, The maximum number of items to return. |
| pageToken: string, The next_page_token value returned from a previous List request, if any. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for ListInboundSamlConfigs |
| "inboundSamlConfigs": [ # The set of configs. |
| { # A pair of SAML RP-IDP configurations when the project acts as the relying party. |
| "displayName": "A String", # The config's display name set by developers. |
| "enabled": True or False, # True if allows the user to sign in with the provider. |
| "idpConfig": { # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. |
| "idpCertificates": [ # IDP's public keys for verifying signature in the assertions. |
| { # The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. |
| "x509Certificate": "A String", # The x509 certificate |
| }, |
| ], |
| "idpEntityId": "A String", # Unique identifier for all SAML entities. |
| "signRequest": True or False, # Indicates if outbounding SAMLRequest should be signed. |
| "ssoUrl": "A String", # URL to send Authentication request to. |
| }, |
| "name": "A String", # The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests. |
| "spConfig": { # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. |
| "callbackUri": "A String", # Callback URI where responses from IDP are handled. |
| "spCertificates": [ # Output only. Public certificates generated by the server to verify the signature in SAMLRequest in the SP-initiated flow. |
| { # The SP's certificate data for IDP to verify the SAMLRequest generated by the SP. |
| "expiresAt": "A String", # Timestamp of the cert expiration instance. |
| "x509Certificate": "A String", # Self-signed public certificate. |
| }, |
| ], |
| "spEntityId": "A String", # Unique identifier for all SAML entities. |
| }, |
| }, |
| ], |
| "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</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="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Update an inbound SAML configuration for an Identity Toolkit project. |
| |
| Args: |
| name: string, The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # A pair of SAML RP-IDP configurations when the project acts as the relying party. |
| "displayName": "A String", # The config's display name set by developers. |
| "enabled": True or False, # True if allows the user to sign in with the provider. |
| "idpConfig": { # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. |
| "idpCertificates": [ # IDP's public keys for verifying signature in the assertions. |
| { # The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. |
| "x509Certificate": "A String", # The x509 certificate |
| }, |
| ], |
| "idpEntityId": "A String", # Unique identifier for all SAML entities. |
| "signRequest": True or False, # Indicates if outbounding SAMLRequest should be signed. |
| "ssoUrl": "A String", # URL to send Authentication request to. |
| }, |
| "name": "A String", # The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests. |
| "spConfig": { # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. |
| "callbackUri": "A String", # Callback URI where responses from IDP are handled. |
| "spCertificates": [ # Output only. Public certificates generated by the server to verify the signature in SAMLRequest in the SP-initiated flow. |
| { # The SP's certificate data for IDP to verify the SAMLRequest generated by the SP. |
| "expiresAt": "A String", # Timestamp of the cert expiration instance. |
| "x509Certificate": "A String", # Self-signed public certificate. |
| }, |
| ], |
| "spEntityId": "A String", # Unique identifier for all SAML entities. |
| }, |
| } |
| |
| updateMask: string, The update mask applies to the resource. Empty update mask will result in updating nothing. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A pair of SAML RP-IDP configurations when the project acts as the relying party. |
| "displayName": "A String", # The config's display name set by developers. |
| "enabled": True or False, # True if allows the user to sign in with the provider. |
| "idpConfig": { # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. # The SAML IdP (Identity Provider) configuration when the project acts as the relying party. |
| "idpCertificates": [ # IDP's public keys for verifying signature in the assertions. |
| { # The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. |
| "x509Certificate": "A String", # The x509 certificate |
| }, |
| ], |
| "idpEntityId": "A String", # Unique identifier for all SAML entities. |
| "signRequest": True or False, # Indicates if outbounding SAMLRequest should be signed. |
| "ssoUrl": "A String", # URL to send Authentication request to. |
| }, |
| "name": "A String", # The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests. |
| "spConfig": { # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. # The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. |
| "callbackUri": "A String", # Callback URI where responses from IDP are handled. |
| "spCertificates": [ # Output only. Public certificates generated by the server to verify the signature in SAMLRequest in the SP-initiated flow. |
| { # The SP's certificate data for IDP to verify the SAMLRequest generated by the SP. |
| "expiresAt": "A String", # Timestamp of the cert expiration instance. |
| "x509Certificate": "A String", # Self-signed public certificate. |
| }, |
| ], |
| "spEntityId": "A String", # Unique identifier for all SAML entities. |
| }, |
| }</pre> |
| </div> |
| |
| </body></html> |
