public static final class ProvidersTypes.CreateSpec extends java.lang.Object implements java.io.Serializable, StaticStructure
CreateSpec
class contains the information used to create an identity
provider. This class was added in vSphere API 7.0.0.0.Modifier and Type | Class and Description |
---|---|
static class |
ProvidersTypes.CreateSpec.Builder
Builder class for
ProvidersTypes.CreateSpec . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
CreateSpec()
Default constructor.
|
protected |
CreateSpec(StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(java.lang.Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
java.lang.String |
_getCanonicalName()
Returns the canonical name of the structure.
|
static java.lang.String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.StructType |
_getClassType()
WARNING: Internal method, subject to change in future versions.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(java.lang.String fieldName)
Get dynamic filed value.
|
java.util.Set<java.lang.String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal method, subject to change in future versions.
|
boolean |
_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Checks if the runtime type name of this structure matches the type
represented by the specified binding class.
|
static ProvidersTypes.CreateSpec |
_newInstance(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized. |
static ProvidersTypes.CreateSpec |
_newInstance2(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
protected void |
_updateDataValue(StructValue structValue) |
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(java.lang.Object obj) |
ProvidersTypes.ActiveDirectoryOverLdap |
getActiveDirectoryOverLdap()
Identity management configuration.
|
java.util.Map<java.lang.String,java.util.List<java.lang.String>> |
getAuthQueryParams()
key/value pairs that are to be appended to the authEndpoint request.
|
ProvidersTypes.ConfigType |
getConfigTag()
The config type of the identity provider.
|
java.util.Set<java.lang.String> |
getDomainNames()
Set of fully qualified domain names to trust when federating with this identity
provider.
|
java.lang.String |
getGroupsClaim()
Specifies which claim provides the group membership for the token subject.
|
java.util.List<java.net.URI> |
getIdmEndpoints()
Identity management endpoints.
|
ProvidersTypes.IdmProtocol |
getIdmProtocol()
Communication protocol to the identity management endpoints.
|
java.lang.Boolean |
getIsDefault()
Specifies whether the provider is the default provider.
|
java.lang.String |
getName()
The user friendly name for the provider.
|
ProvidersTypes.Oauth2CreateSpec |
getOauth2()
OAuth2 CreateSpec.
|
ProvidersTypes.OidcCreateSpec |
getOidc()
OIDC CreateSpec.
|
java.util.Set<java.lang.String> |
getOrgIds()
The set of orgIds as part of SDDC creation which provides the basis for tenancy.
|
java.lang.String |
getUpnClaim()
Specifies which claim provides the user principal name (UPN) for the user.
|
int |
hashCode() |
void |
setActiveDirectoryOverLdap(ProvidersTypes.ActiveDirectoryOverLdap activeDirectoryOverLdap)
Identity management configuration.
|
void |
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.
|
void |
setConfigTag(ProvidersTypes.ConfigType configTag)
The config type of the identity provider.
|
void |
setDomainNames(java.util.Set<java.lang.String> domainNames)
Set of fully qualified domain names to trust when federating with this identity
provider.
|
void |
setGroupsClaim(java.lang.String groupsClaim)
Specifies which claim provides the group membership for the token subject.
|
void |
setIdmEndpoints(java.util.List<java.net.URI> idmEndpoints)
Identity management endpoints.
|
void |
setIdmProtocol(ProvidersTypes.IdmProtocol idmProtocol)
Communication protocol to the identity management endpoints.
|
void |
setIsDefault(java.lang.Boolean isDefault)
Specifies whether the provider is the default provider.
|
void |
setName(java.lang.String name)
The user friendly name for the provider.
|
void |
setOauth2(ProvidersTypes.Oauth2CreateSpec oauth2)
OAuth2 CreateSpec.
|
void |
setOidc(ProvidersTypes.OidcCreateSpec oidc)
OIDC CreateSpec.
|
void |
setOrgIds(java.util.Set<java.lang.String> orgIds)
The set of orgIds as part of SDDC creation which provides the basis for tenancy.
|
void |
setUpnClaim(java.lang.String upnClaim)
Specifies which claim provides the user principal name (UPN) for the user.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public CreateSpec()
protected CreateSpec(StructValue __dynamicStructureFields)
public ProvidersTypes.ConfigType getConfigTag()
public void setConfigTag(ProvidersTypes.ConfigType configTag)
configTag
- New value for the property.public ProvidersTypes.Oauth2CreateSpec getOauth2()
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OAUTH2
.public void setOauth2(ProvidersTypes.Oauth2CreateSpec oauth2)
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OAUTH2
.oauth2
- New value for the property.public ProvidersTypes.OidcCreateSpec getOidc()
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OIDC
.public void setOidc(ProvidersTypes.OidcCreateSpec oidc)
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OIDC
.oidc
- New value for the property.public java.util.Set<java.lang.String> getOrgIds()
null
, the set will be empty.public void setOrgIds(java.util.Set<java.lang.String> orgIds)
null
, the set will be empty.orgIds
- New value for the property.public java.lang.Boolean getIsDefault()
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.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.public void 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.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 java.lang.String getName()
null
, the name will be the empty stringpublic void setName(java.lang.String name)
null
, the name will be the empty stringname
- New value for the property.public java.util.Set<java.lang.String> getDomainNames()
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.public void 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 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAuthQueryParams()
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.public void 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.IdmProtocol getIdmProtocol()
null
, no communication protocol will be configured for the identity
provider.public void setIdmProtocol(ProvidersTypes.IdmProtocol idmProtocol)
null
, no communication protocol will be configured for the identity
provider.idmProtocol
- New value for the property.public java.util.List<java.net.URI> getIdmEndpoints()
getIdmProtocol()
is one of ProvidersTypes.IdmProtocol.REST
, ProvidersTypes.IdmProtocol.SCIM
, or ProvidersTypes.IdmProtocol.SCIM2_0
.public void 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.ActiveDirectoryOverLdap getActiveDirectoryOverLdap()
getIdmProtocol()
is ProvidersTypes.IdmProtocol.LDAP
.public void setActiveDirectoryOverLdap(ProvidersTypes.ActiveDirectoryOverLdap activeDirectoryOverLdap)
getIdmProtocol()
is ProvidersTypes.IdmProtocol.LDAP
.activeDirectoryOverLdap
- New value for the property.public java.lang.String getUpnClaim()
null
, the claim named 'acct' will be used to provide backwards
compatibility with CSP.public void 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 java.lang.String getGroupsClaim()
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.public void 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 com.vmware.vapi.bindings.type.StructType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
Structure
represented in the dynamic
DataValue
model.
Attempts to change the returned StructValue
representation are not required to change the state of this structure.
Actually the behavior is implementation dependent and is unspecified.
In general the returned value shouldn't be changed.
_getDataValue
in interface Structure
StructValue
representing this structureprotected void _updateDataValue(StructValue structValue)
public void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
StaticStructure
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.
toString
in interface StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Structure
This can be used as efficient check to determine if this instance
can be successfully converted
to the target
type.
_hasTypeNameOf
in interface Structure
clazz
- bindings class for the target structure; must not be null
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(java.lang.String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(java.lang.String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic java.util.Set<java.lang.String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public java.lang.String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static ProvidersTypes.CreateSpec _newInstance(StructValue structValue)
structValue
- the source of the data contained in the binding object. Could
contain more data than fields of this class can describe i.e.
newer version of the binding object. Could be null.StructType
public static ProvidersTypes.CreateSpec _newInstance2(StructValue structValue)