com.google.api.services.cloudidentity.v1.model

Class SamlIdpConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.cloudidentity.v1.model.SamlIdpConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class SamlIdpConfig
extends com.google.api.client.json.GenericJson

SAML IDP (identity provider) configuration.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Identity API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
SamlIdpConfig()

Method Summary

Modifier and Type	Method and Description
SamlIdpConfig	clone()
String	getChangePasswordUri() The **Change Password URL** of the identity provider.
String	getEntityId() Required.
String	getLogoutRedirectUri() The **Logout Redirect URL** (sign-out page URL) of the identity provider.
String	getSingleSignOnServiceUri() Required.
SamlIdpConfig	set(String fieldName, Object value)
SamlIdpConfig	setChangePasswordUri(String changePasswordUri) The **Change Password URL** of the identity provider.
SamlIdpConfig	setEntityId(String entityId) Required.
SamlIdpConfig	setLogoutRedirectUri(String logoutRedirectUri) The **Logout Redirect URL** (sign-out page URL) of the identity provider.
SamlIdpConfig	setSingleSignOnServiceUri(String singleSignOnServiceUri) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

SamlIdpConfig

public SamlIdpConfig()

Method Detail

getChangePasswordUri

public String getChangePasswordUri()

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`.

Returns:

value or null for none

setChangePasswordUri

public SamlIdpConfig setChangePasswordUri(String changePasswordUri)

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`.

Parameters:

changePasswordUri - changePasswordUri or null for none

getEntityId

public String getEntityId()

Required. The SAML **Entity ID** of the identity provider.

Returns:

value or null for none

setEntityId

public SamlIdpConfig setEntityId(String entityId)

Required. The SAML **Entity ID** of the identity provider.

Parameters:

entityId - entityId or null for none

getLogoutRedirectUri

public String getLogoutRedirectUri()

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`.

Returns:

value or null for none

setLogoutRedirectUri

public SamlIdpConfig setLogoutRedirectUri(String logoutRedirectUri)

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`.

Parameters:

logoutRedirectUri - logoutRedirectUri or null for none

getSingleSignOnServiceUri

public String getSingleSignOnServiceUri()

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.

Returns:

value or null for none

setSingleSignOnServiceUri

public SamlIdpConfig setSingleSignOnServiceUri(String singleSignOnServiceUri)

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.

Parameters:

singleSignOnServiceUri - singleSignOnServiceUri or null for none

set

public SamlIdpConfig set(String fieldName,
                         Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public SamlIdpConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson