com.vmware.vcenter.identity

Class ProvidersTypes.UpdateSpec.Builder

java.lang.Object

com.vmware.vcenter.identity.ProvidersTypes.UpdateSpec.Builder

Enclosing class:

ProvidersTypes.UpdateSpec

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

Builder class for ProvidersTypes.UpdateSpec.

Constructor Summary

Constructors

Constructor and Description
Builder(ProvidersTypes.ConfigType configTag) Constructor with parameters for the required properties of ProvidersTypes.UpdateSpec.

Method Summary

Modifier and Type	Method and Description
ProvidersTypes.UpdateSpec	build()
ProvidersTypes.UpdateSpec.Builder	setActiveDirectoryOverLdap(ProvidersTypes.ActiveDirectoryOverLdap activeDirectoryOverLdap) Identity management configuration.
ProvidersTypes.UpdateSpec.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.UpdateSpec.Builder	setDomainNames(java.util.Set<java.lang.String> domainNames) Set of fully qualified domain names to trust when federating with this identity provider.
ProvidersTypes.UpdateSpec.Builder	setGroupsClaim(java.lang.String groupsClaim) Specifies which claim provides the group membership for the token subject.
ProvidersTypes.UpdateSpec.Builder	setIdmEndpoints(java.util.List<java.net.URI> idmEndpoints) Identity management endpoints.
ProvidersTypes.UpdateSpec.Builder	setIdmProtocol(ProvidersTypes.IdmProtocol idmProtocol) The protocol to communicate to the identity management endpoints.
ProvidersTypes.UpdateSpec.Builder	setMakeDefault(java.lang.Boolean makeDefault) Specifies whether to make this the default provider.
ProvidersTypes.UpdateSpec.Builder	setName(java.lang.String name) The user friendly name for the provider.
ProvidersTypes.UpdateSpec.Builder	setOauth2(ProvidersTypes.Oauth2UpdateSpec oauth2) OAuth2 UpdateSpec.
ProvidersTypes.UpdateSpec.Builder	setOidc(ProvidersTypes.OidcUpdateSpec oidc) OIDC UpdateSpec.
ProvidersTypes.UpdateSpec.Builder	setOrgIds(java.util.Set<java.lang.String> orgIds) The set orgIds as part of SDDC creation which provides the basis for tenancy.
ProvidersTypes.UpdateSpec.Builder	setResetGroupsClaim(java.lang.Boolean resetGroupsClaim) Flag indicating whether any existing groups claim value should be removed.
ProvidersTypes.UpdateSpec.Builder	setResetUpnClaim(java.lang.Boolean resetUpnClaim) Flag indicating whether the user principal name (UPN) claim should be set back to its default value.
ProvidersTypes.UpdateSpec.Builder	setUpnClaim(java.lang.String upnClaim) Specifies which claim provides the user principal name (UPN) for the subject of the token.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(ProvidersTypes.ConfigType configTag)

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

Method Detail

setOauth2

public ProvidersTypes.UpdateSpec.Builder setOauth2(ProvidersTypes.Oauth2UpdateSpec oauth2)

OAuth2 UpdateSpec. This property was added in vSphere API 7.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.UpdateSpec.Builder setOidc(ProvidersTypes.OidcUpdateSpec oidc)

OIDC UpdateSpec. This property was added in vSphere API 7.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.

setOrgIds

public ProvidersTypes.UpdateSpec.Builder setOrgIds(java.util.Set<java.lang.String> orgIds)

The set orgIds as part of SDDC creation which provides the basis for tenancy. This property was added in vSphere API 7.0.0. If null, leaves value unchanged.

Parameters:

orgIds - New value for the property.

setMakeDefault

public ProvidersTypes.UpdateSpec.Builder setMakeDefault(java.lang.Boolean makeDefault)

Specifies whether to make this the default provider. If getMakeDefault() is set to true, this provider will be flagged as the default provider and any other providers that had previously been flagged as the default will be made non-default. If getMakeDefault() is set to false, this provider's default flag will not be modified. This property was added in vSphere API 7.0.0. If null, leaves value unchanged.

Parameters:

makeDefault - New value for the property.

setName

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

The user friendly name for the provider. This name can be used for human-readable identification purposes, but it does not have to be unique, as the system will use internal UUIDs to differentiate providers. This property was added in vSphere API 7.0.0. If null, leaves value unchanged.

Parameters:

name - New value for the property.

setDomainNames

public ProvidersTypes.UpdateSpec.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. This property was added in vSphere API 7.0.0. If null, leaves value unchanged. 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.

Parameters:

domainNames - New value for the property.

setAuthQueryParams

public ProvidersTypes.UpdateSpec.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. If the map is empty, deletes all params. This property was added in vSphere API 7.0.0. If null, leaves value unchanged.

Parameters:

authQueryParams - New value for the property.

setIdmProtocol

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

The protocol to communicate to the identity management endpoints. This property was added in vSphere API 7.0.0. If null, leave value unchanged.

Parameters:

idmProtocol - New value for the property.

setIdmEndpoints

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

Identity management endpoints. When specified, at least one endpoint must be provided. This property was added in vSphere API 7.0.0. This property is optional and it is only relevant when the value of getIdmProtocol() is one of ProvidersTypes.IdmProtocol.REST or ProvidersTypes.IdmProtocol.SCIM.

Parameters:

idmEndpoints - New value for the property.

setActiveDirectoryOverLdap

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

Identity management configuration. If the protocol is LDAP, the configuration must be set, else InvalidArgument is thrown. This property was added in vSphere API 7.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.UpdateSpec.Builder setUpnClaim(java.lang.String upnClaim)

Specifies which claim provides the user principal name (UPN) for the subject of the token. This property was added in vSphere API 7.0.0. If null, leaves value unchanged.

Parameters:

upnClaim - New value for the property.

setResetUpnClaim

public ProvidersTypes.UpdateSpec.Builder setResetUpnClaim(java.lang.Boolean resetUpnClaim)

Flag indicating whether the user principal name (UPN) claim should be set back to its default value. If this field is set to true, the user principal name (UPN) claim will be set to 'acct', which is used for backwards compatibility with CSP. If this field is set to false, the existing user principal name (UPN) claim will be changed to the value specified in ProvidersTypes.UpdateSpec.getUpnClaim(), if any. This property was added in vSphere API 7.0.0. If null, the existing user principal name (UPN) claim will be changed to the value specified in ProvidersTypes.UpdateSpec.getUpnClaim(), if any.

Parameters:

resetUpnClaim - New value for the property.

setGroupsClaim

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

Specifies which claim provides the group membership for the token subject. This property was added in vSphere API 7.0.0. If null, leaves value unchanged.

Parameters:

groupsClaim - New value for the property.

setResetGroupsClaim

public ProvidersTypes.UpdateSpec.Builder setResetGroupsClaim(java.lang.Boolean resetGroupsClaim)

Flag indicating whether any existing groups claim value should be removed. If this field is set to true, the existing groups claim value is removed which defaults to backwards compatibility with CSP. In this case, the groups for the subject will be comprised of the groups in 'group_names' and 'group_ids' claims. If this field is set to false, the existing groups claim will be changed to the value specified in ProvidersTypes.UpdateSpec.getGroupsClaim(), if any. This property was added in vSphere API 7.0.0. If null, the existing groups claim will be changed to the value specified in ProvidersTypes.UpdateSpec.getGroupsClaim(), if any.

Parameters:

resetGroupsClaim - New value for the property.

build

public ProvidersTypes.UpdateSpec build()