com.vmware.vcenter.identity

Class ProvidersTypes.Info.Builder

java.lang.Object

com.vmware.vcenter.identity.ProvidersTypes.Info.Builder

Enclosing class:

ProvidersTypes.Info

public static final class ProvidersTypes.Info.Builder
extends java.lang.Object

Builder class for ProvidersTypes.Info.

Constructor Summary

Constructors

Constructor and Description
Builder(java.util.Set<java.lang.String> orgIds, ProvidersTypes.ConfigType configTag, boolean isDefault) Constructor with parameters for the required properties of ProvidersTypes.Info.

Method Summary

Modifier and Type	Method and Description
ProvidersTypes.Info	build()
ProvidersTypes.Info.Builder	setActiveDirectoryOverLdap(ProvidersTypes.ActiveDirectoryOverLdap activeDirectoryOverLdap) Identity management configuration.
ProvidersTypes.Info.Builder	setAuthQueryParams(java.util.Map<java.lang.String,java.util.List<java.lang.String>> authQueryParams) key/value pairs that are to be appended to the authEndpoint request.
ProvidersTypes.Info.Builder	setDomainNames(java.util.Set<java.lang.String> domainNames) Set of fully qualified domain names to trust when federating with this identity provider.
ProvidersTypes.Info.Builder	setGroupsClaim(java.lang.String groupsClaim) Specifies which claim provides the group membership for the token subject.
ProvidersTypes.Info.Builder	setIdmEndpoints(java.util.List<java.net.URI> idmEndpoints) Identity management endpoints.
ProvidersTypes.Info.Builder	setIdmProtocol(ProvidersTypes.IdmProtocol idmProtocol) Communication protocol to the identity management endpoints.
ProvidersTypes.Info.Builder	setName(java.lang.String name) The user friendly name for the provider.
ProvidersTypes.Info.Builder	setOauth2(ProvidersTypes.Oauth2Info oauth2) OAuth2 Info.
ProvidersTypes.Info.Builder	setOidc(ProvidersTypes.OidcInfo oidc) OIDC Info.
ProvidersTypes.Info.Builder	setUpnClaim(java.lang.String upnClaim) Specifies which claim provides the user principal name (UPN) for the user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(java.util.Set<java.lang.String> orgIds,
               ProvidersTypes.ConfigType configTag,
               boolean isDefault)

Constructor with parameters for the required properties of ProvidersTypes.Info.

Method Detail

setName

public ProvidersTypes.Info.Builder setName(java.lang.String name)

The user friendly name for the provider. This property was added in vSphere API 7.0.0.0. This property is optional because it was added in a newer version than its parent node.

Parameters:

name - New value for the property.

setOauth2

public ProvidersTypes.Info.Builder setOauth2(ProvidersTypes.Oauth2Info oauth2)

OAuth2 Info. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getConfigTag() is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OAUTH2.

Parameters:

oauth2 - New value for the property.

setOidc

public ProvidersTypes.Info.Builder setOidc(ProvidersTypes.OidcInfo oidc)

OIDC Info. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getConfigTag() is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OIDC.

Parameters:

oidc - New value for the property.

setDomainNames

public ProvidersTypes.Info.Builder setDomainNames(java.util.Set<java.lang.String> domainNames)

Set of fully qualified domain names to trust when federating with this identity provider. Tokens from this identity provider will only be validated if the user belongs to one of these domains, and any domain-qualified groups in the tokens will be filtered to include only those groups that belong to one of these domains. If domainNames is an empty set, domain validation behavior at login with this identity provider will be as follows: the user's domain will be parsed from the User Principal Name (UPN) value that is found in the tokens returned by the identity provider. This domain will then be implicitly trusted and used to filter any groups that are also provided in the tokens. This property was added in vSphere API 7.0.0.0. This property is optional because it was added in a newer version than its parent node.

Parameters:

domainNames - New value for the property.

setAuthQueryParams

public ProvidersTypes.Info.Builder setAuthQueryParams(java.util.Map<java.lang.String,java.util.List<java.lang.String>> authQueryParams)

key/value pairs that are to be appended to the authEndpoint request.

How to append to authEndpoint request:

If the map is not empty, a "?" is added to the endpoint URL, and combination of each k and each string in the v is added with an "&" delimiter. Details:

• If the value contains only one string, then the key is added with "k=v".
• If the value is an empty list, then the key is added without a "=v".
• If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.

. This property was added in vSphere API 7.0.0.0. This property is optional because it was added in a newer version than its parent node.

Parameters:

authQueryParams - New value for the property.

setIdmProtocol

public ProvidersTypes.Info.Builder setIdmProtocol(ProvidersTypes.IdmProtocol idmProtocol)

Communication protocol to the identity management endpoints. This property was added in vSphere API 7.0.0.0. This property is optional because it was added in a newer version than its parent node.

Parameters:

idmProtocol - New value for the property.

setIdmEndpoints

public ProvidersTypes.Info.Builder setIdmEndpoints(java.util.List<java.net.URI> idmEndpoints)

Identity management endpoints. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getIdmProtocol() is one of ProvidersTypes.IdmProtocol.REST, ProvidersTypes.IdmProtocol.SCIM, or ProvidersTypes.IdmProtocol.SCIM2_0.

Parameters:

idmEndpoints - New value for the property.

setActiveDirectoryOverLdap

public ProvidersTypes.Info.Builder setActiveDirectoryOverLdap(ProvidersTypes.ActiveDirectoryOverLdap activeDirectoryOverLdap)

Identity management configuration. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getIdmProtocol() is ProvidersTypes.IdmProtocol.LDAP.

Parameters:

activeDirectoryOverLdap - New value for the property.

setUpnClaim

public ProvidersTypes.Info.Builder setUpnClaim(java.lang.String upnClaim)

Specifies which claim provides the user principal name (UPN) for the user. This property was added in vSphere API 7.0.0.0. This property is optional because it was added in a newer version than its parent node.

Parameters:

upnClaim - New value for the property.

setGroupsClaim

public ProvidersTypes.Info.Builder setGroupsClaim(java.lang.String groupsClaim)

Specifies which claim provides the group membership for the token subject. If empty, the default behavior for CSP is used. In this case, the groups for the subject will be comprised of the groups in 'group_names' and 'group_ids' claims. This property was added in vSphere API 7.0.0.0. This property is optional because it was added in a newer version than its parent node.

Parameters:

groupsClaim - New value for the property.

build

public ProvidersTypes.Info build()