public static final class ProvidersTypes.UpdateSpec extends java.lang.Object implements java.io.Serializable, StaticStructure
UpdateSpec
class contains the information used to update the
identity provider. This class was added in vSphere API 7.0.0.0.Modifier and Type | Class and Description |
---|---|
static class |
ProvidersTypes.UpdateSpec.Builder
Builder class for
ProvidersTypes.UpdateSpec . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
UpdateSpec()
Default constructor.
|
protected |
UpdateSpec(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.UpdateSpec |
_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.UpdateSpec |
_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()
The protocol to communicate to the identity management endpoints.
|
java.lang.Boolean |
getMakeDefault()
Specifies whether to make this the default provider.
|
java.lang.String |
getName()
The user friendly name for the provider.
|
ProvidersTypes.Oauth2UpdateSpec |
getOauth2()
OAuth2 UpdateSpec.
|
ProvidersTypes.OidcUpdateSpec |
getOidc()
OIDC UpdateSpec.
|
java.util.Set<java.lang.String> |
getOrgIds()
The set orgIds as part of SDDC creation which provides the basis for tenancy.
|
java.lang.Boolean |
getResetGroupsClaim()
Flag indicating whether any existing groups claim value should be removed.
|
java.lang.Boolean |
getResetUpnClaim()
Flag indicating whether the user principal name (UPN) claim should be set back
to its default value.
|
java.lang.String |
getUpnClaim()
Specifies which claim provides the user principal name (UPN) for the subject of
the token.
|
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)
The protocol to communicate to the identity management endpoints.
|
void |
setMakeDefault(java.lang.Boolean makeDefault)
Specifies whether to make this the default provider.
|
void |
setName(java.lang.String name)
The user friendly name for the provider.
|
void |
setOauth2(ProvidersTypes.Oauth2UpdateSpec oauth2)
OAuth2 UpdateSpec.
|
void |
setOidc(ProvidersTypes.OidcUpdateSpec oidc)
OIDC UpdateSpec.
|
void |
setOrgIds(java.util.Set<java.lang.String> orgIds)
The set orgIds as part of SDDC creation which provides the basis for tenancy.
|
void |
setResetGroupsClaim(java.lang.Boolean resetGroupsClaim)
Flag indicating whether any existing groups claim value should be removed.
|
void |
setResetUpnClaim(java.lang.Boolean resetUpnClaim)
Flag indicating whether the user principal name (UPN) claim should be set back
to its default value.
|
void |
setUpnClaim(java.lang.String upnClaim)
Specifies which claim provides the user principal name (UPN) for the subject of
the token.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public UpdateSpec()
protected UpdateSpec(StructValue __dynamicStructureFields)
public ProvidersTypes.ConfigType getConfigTag()
public void setConfigTag(ProvidersTypes.ConfigType configTag)
configTag
- New value for the property.public ProvidersTypes.Oauth2UpdateSpec getOauth2()
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OAUTH2
.public void setOauth2(ProvidersTypes.Oauth2UpdateSpec oauth2)
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OAUTH2
.oauth2
- New value for the property.public ProvidersTypes.OidcUpdateSpec getOidc()
getConfigTag()
is com.vmware.vcenter.identity.ProvidersTypes.ConfigType#OIDC
.public void setOidc(ProvidersTypes.OidcUpdateSpec 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
, leaves value unchanged.public void setOrgIds(java.util.Set<java.lang.String> orgIds)
null
, leaves value unchanged.orgIds
- New value for the property.public java.lang.Boolean getMakeDefault()
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.public void 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 java.lang.String getName()
null
, leaves value unchanged.public void setName(java.lang.String name)
null
, leaves value unchanged.name
- New value for the property.public java.util.Set<java.lang.String> getDomainNames()
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.public void 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 java.util.Map<java.lang.String,java.util.List<java.lang.String>> getAuthQueryParams()
null
, leaves value unchanged.public void 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.IdmProtocol getIdmProtocol()
null
, leave value unchanged.public void setIdmProtocol(ProvidersTypes.IdmProtocol idmProtocol)
null
, leave value unchanged.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
, leaves value unchanged.public void setUpnClaim(java.lang.String upnClaim)
null
, leaves value unchanged.upnClaim
- New value for the property.public java.lang.Boolean getResetUpnClaim()
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 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 getUpnClaim()
, if any.public void 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 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 getUpnClaim()
, if any.resetUpnClaim
- New value for the property.public java.lang.String getGroupsClaim()
null
, leaves value unchanged.public void setGroupsClaim(java.lang.String groupsClaim)
null
, leaves value unchanged.groupsClaim
- New value for the property.public java.lang.Boolean getResetGroupsClaim()
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 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 getGroupsClaim()
, if any.public void 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 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 getGroupsClaim()
, if any.resetGroupsClaim
- 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.UpdateSpec _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.UpdateSpec _newInstance2(StructValue structValue)