Class: Google::Apis::CloudidentityV1::SamlIdpConfig
- Inherits:
-
Object
- Object
- Google::Apis::CloudidentityV1::SamlIdpConfig
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/cloudidentity_v1/classes.rb,
lib/google/apis/cloudidentity_v1/representations.rb,
lib/google/apis/cloudidentity_v1/representations.rb
Overview
SAML IDP (identity provider) configuration.
Instance Attribute Summary collapse
-
#change_password_uri ⇒ String
The Change Password URL of the identity provider.
-
#entity_id ⇒ String
Required.
-
#logout_redirect_uri ⇒ String
The Logout Redirect URL (sign-out page URL) of the identity provider.
-
#single_sign_on_service_uri ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SamlIdpConfig
constructor
A new instance of SamlIdpConfig.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ SamlIdpConfig
Returns a new instance of SamlIdpConfig.
2424 2425 2426 |
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2424 def initialize(**args) update!(**args) end |
Instance Attribute Details
#change_password_uri ⇒ String
The Change Password URL of the identity provider. Users will be sent to
this URL when changing their passwords at myaccount.google.com
. This takes
precedence over the change password URL configured at customer-level. Must use
HTTPS
.
Corresponds to the JSON property changePasswordUri
2402 2403 2404 |
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2402 def change_password_uri @change_password_uri end |
#entity_id ⇒ String
Required. The SAML Entity ID of the identity provider.
Corresponds to the JSON property entityId
2407 2408 2409 |
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2407 def entity_id @entity_id end |
#logout_redirect_uri ⇒ String
The Logout Redirect URL (sign-out page URL) of the identity provider. When
a user clicks the sign-out link on a Google page, they will be redirected to
this URL. This is a pure redirect with no attached SAML LogoutRequest
i.e.
SAML single logout is not supported. Must use HTTPS
.
Corresponds to the JSON property logoutRedirectUri
2415 2416 2417 |
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2415 def logout_redirect_uri @logout_redirect_uri end |
#single_sign_on_service_uri ⇒ String
Required. The SingleSignOnService
endpoint location (sign-in page URL) of
the identity provider. This is the URL where the AuthnRequest
will be sent.
Must use HTTPS
. Assumed to accept the HTTP-Redirect
binding.
Corresponds to the JSON property singleSignOnServiceUri
2422 2423 2424 |
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2422 def single_sign_on_service_uri @single_sign_on_service_uri end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2429 2430 2431 2432 2433 2434 |
# File 'lib/google/apis/cloudidentity_v1/classes.rb', line 2429 def update!(**args) @change_password_uri = args[:change_password_uri] if args.key?(:change_password_uri) @entity_id = args[:entity_id] if args.key?(:entity_id) @logout_redirect_uri = args[:logout_redirect_uri] if args.key?(:logout_redirect_uri) @single_sign_on_service_uri = args[:single_sign_on_service_uri] if args.key?(:single_sign_on_service_uri) end |