public static final class ProvidersTypes.CreateSpec.Builder
extends java.lang.Object
ProvidersTypes.CreateSpec
.Constructor and Description |
---|
Builder(ProvidersTypes.ConfigType configTag)
Constructor with parameters for the required properties of
ProvidersTypes.CreateSpec . |
Modifier and Type | Method and Description |
---|---|
ProvidersTypes.CreateSpec |
build() |
ProvidersTypes.CreateSpec.Builder |
setActiveDirectoryOverLdap(ProvidersTypes.ActiveDirectoryOverLdap activeDirectoryOverLdap)
Identity management configuration.
|
ProvidersTypes.CreateSpec.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.CreateSpec.Builder |
setDomainNames(java.util.Set<java.lang.String> domainNames)
Set of fully qualified domain names to trust when federating with this identity
provider.
|
ProvidersTypes.CreateSpec.Builder |
setGroupsClaim(java.lang.String groupsClaim)
Specifies which claim provides the group membership for the token subject.
|
ProvidersTypes.CreateSpec.Builder |
setIdmEndpoints(java.util.List<java.net.URI> idmEndpoints)
Identity management endpoints.
|
ProvidersTypes.CreateSpec.Builder |
setIdmProtocol(ProvidersTypes.IdmProtocol idmProtocol)
Communication protocol to the identity management endpoints.
|
ProvidersTypes.CreateSpec.Builder |
setIsDefault(java.lang.Boolean isDefault)
Specifies whether the provider is the default provider.
|
ProvidersTypes.CreateSpec.Builder |
setName(java.lang.String name)
The user friendly name for the provider.
|
ProvidersTypes.CreateSpec.Builder |
setOauth2(ProvidersTypes.Oauth2CreateSpec oauth2)
OAuth2 CreateSpec.
|
ProvidersTypes.CreateSpec.Builder |
setOidc(ProvidersTypes.OidcCreateSpec oidc)
OIDC CreateSpec.
|
ProvidersTypes.CreateSpec.Builder |
setOrgIds(java.util.Set<java.lang.String> orgIds)
The set of orgIds as part of SDDC creation which provides the basis for tenancy.
|
ProvidersTypes.CreateSpec.Builder |
setUpnClaim(java.lang.String upnClaim)
Specifies which claim provides the user principal name (UPN) for the user.
|
public Builder(ProvidersTypes.ConfigType configTag)
ProvidersTypes.CreateSpec
.public ProvidersTypes.CreateSpec.Builder setOauth2(ProvidersTypes.Oauth2CreateSpec oauth2)
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OAUTH2
.oauth2
- New value for the property.public ProvidersTypes.CreateSpec.Builder setOidc(ProvidersTypes.OidcCreateSpec oidc)
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OIDC
.oidc
- New value for the property.public ProvidersTypes.CreateSpec.Builder setOrgIds(java.util.Set<java.lang.String> orgIds)
null
, the set will be empty.orgIds
- New value for the property.public ProvidersTypes.CreateSpec.Builder setIsDefault(java.lang.Boolean isDefault)
getIsDefault()
of current provider to True makes all other providers
non-default. If no other providers created in this vCenter Server before, this
parameter will be disregarded, and the provider will always be set to the
default. This property was added in vSphere API 7.0.0.
If null
the provider will be the default provider if it is the first
provider that is created, and will not be the default provider otherwise.isDefault
- New value for the property.public ProvidersTypes.CreateSpec.Builder setName(java.lang.String name)
null
, the name will be the empty stringname
- New value for the property.public ProvidersTypes.CreateSpec.Builder setDomainNames(java.util.Set<java.lang.String> domainNames)
null
, domainNames will be the empty set and the 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.CreateSpec.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:null
, the map will be empty.authQueryParams
- New value for the property.public ProvidersTypes.CreateSpec.Builder setIdmProtocol(ProvidersTypes.IdmProtocol idmProtocol)
null
, no communication protocol will be configured for the identity
provider.idmProtocol
- New value for the property.public ProvidersTypes.CreateSpec.Builder setIdmEndpoints(java.util.List<java.net.URI> idmEndpoints)
getIdmProtocol()
is one of ProvidersTypes.IdmProtocol.REST
or ProvidersTypes.IdmProtocol.SCIM
.idmEndpoints
- New value for the property.public ProvidersTypes.CreateSpec.Builder setActiveDirectoryOverLdap(ProvidersTypes.ActiveDirectoryOverLdap activeDirectoryOverLdap)
getIdmProtocol()
is ProvidersTypes.IdmProtocol.LDAP
.activeDirectoryOverLdap
- New value for the property.public ProvidersTypes.CreateSpec.Builder setUpnClaim(java.lang.String upnClaim)
null
, the claim named 'acct' will be used to provide backwards
compatibility with CSP.upnClaim
- New value for the property.public ProvidersTypes.CreateSpec.Builder setGroupsClaim(java.lang.String groupsClaim)
null
, the default behavior will be CSP backwards compatiblility. The
groups for the subject will be comprised of the groups in 'group_names' and
'group_ids' claims.groupsClaim
- New value for the property.public ProvidersTypes.CreateSpec build()