public static final class ProvidersTypes.UpdateSpec.Builder
extends java.lang.Object
ProvidersTypes.UpdateSpec
.Constructor and Description |
---|
Builder(ProvidersTypes.ConfigType configTag)
Constructor with parameters for the required properties of
ProvidersTypes.UpdateSpec . |
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.
|
public Builder(ProvidersTypes.ConfigType configTag)
ProvidersTypes.UpdateSpec
.public ProvidersTypes.UpdateSpec.Builder setOauth2(ProvidersTypes.Oauth2UpdateSpec oauth2)
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OAUTH2
.oauth2
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setOidc(ProvidersTypes.OidcUpdateSpec oidc)
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OIDC
.oidc
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setOrgIds(java.util.Set<java.lang.String> orgIds)
null
, leaves value unchanged.orgIds
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setMakeDefault(java.lang.Boolean makeDefault)
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.0.
If null
, leaves value unchanged.makeDefault
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setName(java.lang.String name)
null
, leaves value unchanged.name
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setDomainNames(java.util.Set<java.lang.String> domainNames)
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.domainNames
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setAuthQueryParams(java.util.Map<java.lang.String,java.util.List<java.lang.String>> authQueryParams)
null
, leaves value unchanged.authQueryParams
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setIdmProtocol(ProvidersTypes.IdmProtocol idmProtocol)
null
, leave value unchanged.idmProtocol
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setIdmEndpoints(java.util.List<java.net.URI> idmEndpoints)
getIdmProtocol()
is one of ProvidersTypes.IdmProtocol.REST
, ProvidersTypes.IdmProtocol.SCIM
, or ProvidersTypes.IdmProtocol.SCIM2_0
.idmEndpoints
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setActiveDirectoryOverLdap(ProvidersTypes.ActiveDirectoryOverLdap activeDirectoryOverLdap)
getIdmProtocol()
is ProvidersTypes.IdmProtocol.LDAP
.activeDirectoryOverLdap
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setUpnClaim(java.lang.String upnClaim)
null
, leaves value unchanged.upnClaim
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setResetUpnClaim(java.lang.Boolean resetUpnClaim)
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.0.
If null
, the existing user principal name (UPN) claim will be changed to
the value specified in ProvidersTypes.UpdateSpec.getUpnClaim()
, if any.resetUpnClaim
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setGroupsClaim(java.lang.String groupsClaim)
null
, leaves value unchanged.groupsClaim
- New value for the property.public ProvidersTypes.UpdateSpec.Builder setResetGroupsClaim(java.lang.Boolean resetGroupsClaim)
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.0.
If null
, the existing groups claim will be changed to the value
specified in ProvidersTypes.UpdateSpec.getGroupsClaim()
, if any.resetGroupsClaim
- New value for the property.public ProvidersTypes.UpdateSpec build()