public final class OidcEndPoint
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
Modifier and Type | Class and Description |
---|---|
static class |
OidcEndPoint.Builder
Builder class for
OidcEndPoint . |
Modifier and Type | Field and Description |
---|---|
protected com.vmware.vapi.data.StructValue |
__dynamicStructureFields |
static java.lang.String |
OIDC_TYPE_CSP |
static java.lang.String |
OIDC_TYPE_VCENTER |
static java.lang.String |
OIDC_TYPE_WS_ONE |
Modifier | Constructor and Description |
---|---|
|
OidcEndPoint()
Default constructor.
|
protected |
OidcEndPoint(com.vmware.vapi.data.StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends com.vmware.vapi.bindings.Structure> |
_convertTo(java.lang.Class<T> clazz) |
java.lang.String |
_getCanonicalName() |
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.
|
com.vmware.vapi.data.StructValue |
_getDataValue() |
com.vmware.vapi.data.DataValue |
_getDynamicField(java.lang.String fieldName) |
java.util.Set<java.lang.String> |
_getDynamicFieldNames() |
com.vmware.vapi.bindings.type.StructType |
_getType() |
boolean |
_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz) |
static OidcEndPoint |
_newInstance(com.vmware.vapi.data.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 OidcEndPoint |
_newInstance2(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
com.vmware.vapi.data.DataValue fieldValue) |
protected void |
_updateDataValue(com.vmware.vapi.data.StructValue structValue) |
void |
_validate() |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getAuthorizationEndpoint()
The URL of the OpenID provider's authorization endpoint.
|
java.util.List<ClaimMap> |
getClaimMap()
Configuration for mapping claims in OIDC ID tokens to NSX roles.
|
java.util.List<java.lang.String> |
getClaimsSupported()
The list of claims that the OpenID provider supports.
|
java.lang.String |
getClientId()
The client ID for NSX to use when authenticating via this OIDC provider.
|
java.lang.String |
getClientSecret()
The client secret for NSX to use when authenticating via this OIDC provider.
|
java.lang.Long |
getCreateTime()
Timestamp of resource creation format: int64
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
java.lang.String |
getCreateUser()
ID of the user who created this resource
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
CspConfig |
getCspConfig() |
java.lang.String |
getDescription()
Description of this resource
|
java.lang.String |
getDisplayName()
Defaults to ID if not set
|
java.lang.String |
getEndSessionEndpointUri()
URI of the OpenID session logout end-point.
|
java.lang.String |
getId()
Unique identifier of this resource
|
java.lang.String |
getIssuer()
Issuer of the JWT tokens for the given type.
|
java.lang.String |
getJwksUri()
The URI where the JWKS document is located that has the key used to validate the
JWT signature.
|
java.lang.Long |
getLastModifiedTime()
Timestamp of last modification format: int64
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
java.lang.String |
getLastModifiedUser()
ID of the user who last modified this resource
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
java.util.List<ResourceLink> |
getLinks()
The server will populate this field when returing the resource.
|
java.lang.String |
getName()
A short, unique name for this OpenID Connect end-point.
|
java.lang.String |
getOidcType()
Possible values are:
OIDC_TYPE_VCENTER OIDC_TYPE_WS_ONE OIDC_TYPE_CSP Type used to
distinguish the OIDC end-points by IDP. |
java.lang.String |
getOidcUri()
URI of the OpenID Connect end-point.
|
java.util.List<java.lang.String> |
getOverrideRoles()
When specified this role or roles are used instead of the nsx-role in the JWT
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
java.lang.String |
getProtection()
Protection status is one of the following: PROTECTED - the client who retrieved
the entity is not allowed to modify it.
|
java.lang.String |
getResourceType()
The type of this resource.
|
java.lang.Boolean |
getRestrictScimSearch()
If set to true, then it is only possible to perform a SCIM search against the
OIDC provider used to authenticate.
|
java.lang.Long |
getRevision()
The _revision property describes the current revision of the resource.
|
java.lang.String |
getSchema()
Schema for this resource
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
java.util.List<java.lang.String> |
getScimEndpoints()
The SCIM (System for Cross-domain Identity Management) endpoint URLs to use when
enumerating users and groups.
|
SelfResourceLink |
getSelf() |
java.util.List<java.lang.String> |
getServicedDomains()
When a login to NSX using a principal name of the form user@domain is attempted,
the list of OIDC providers will be scanned to find one with a matching domain.
|
java.lang.Boolean |
getSystemOwned()
Indicates system owned resource
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
java.util.List<Tag> |
getTags()
Opaque identifiers meaningful to the API user
|
java.lang.String |
getThumbprint()
Thumbprint in SHA-256 format used to verify the server certificate at the URI.
|
java.lang.String |
getTokenEndpoint()
The URL of the OpenID provider's token endpoint.
|
java.lang.String |
getUserinfoEndpoint()
The URL of the OpenID provider's userinfo endpoint.
|
int |
hashCode() |
void |
setAuthorizationEndpoint(java.lang.String authorizationEndpoint)
The URL of the OpenID provider's authorization endpoint.
|
void |
setClaimMap(java.util.List<ClaimMap> claimMap)
Configuration for mapping claims in OIDC ID tokens to NSX roles.
|
void |
setClaimsSupported(java.util.List<java.lang.String> claimsSupported)
The list of claims that the OpenID provider supports.
|
void |
setClientId(java.lang.String clientId)
The client ID for NSX to use when authenticating via this OIDC provider.
|
void |
setClientSecret(java.lang.String clientSecret)
The client secret for NSX to use when authenticating via this OIDC provider.
|
void |
setCreateTime(java.lang.Long createTime)
Timestamp of resource creation format: int64
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
void |
setCreateUser(java.lang.String createUser)
ID of the user who created this resource
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
void |
setCspConfig(CspConfig cspConfig) |
void |
setDescription(java.lang.String description)
Description of this resource
|
void |
setDisplayName(java.lang.String displayName)
Defaults to ID if not set
|
void |
setEndSessionEndpointUri(java.lang.String endSessionEndpointUri)
URI of the OpenID session logout end-point.
|
void |
setId(java.lang.String id)
Unique identifier of this resource
|
void |
setIssuer(java.lang.String issuer)
Issuer of the JWT tokens for the given type.
|
void |
setJwksUri(java.lang.String jwksUri)
The URI where the JWKS document is located that has the key used to validate the
JWT signature.
|
void |
setLastModifiedTime(java.lang.Long lastModifiedTime)
Timestamp of last modification format: int64
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
void |
setLastModifiedUser(java.lang.String lastModifiedUser)
ID of the user who last modified this resource
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
void |
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.
|
void |
setName(java.lang.String name)
A short, unique name for this OpenID Connect end-point.
|
void |
setOidcType(java.lang.String oidcType)
Possible values are:
OIDC_TYPE_VCENTER OIDC_TYPE_WS_ONE OIDC_TYPE_CSP Type used to
distinguish the OIDC end-points by IDP. |
void |
setOidcUri(java.lang.String oidcUri)
URI of the OpenID Connect end-point.
|
void |
setOverrideRoles(java.util.List<java.lang.String> overrideRoles)
When specified this role or roles are used instead of the nsx-role in the JWT
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
void |
setProtection(java.lang.String protection)
Protection status is one of the following: PROTECTED - the client who retrieved
the entity is not allowed to modify it.
|
void |
setResourceType(java.lang.String resourceType)
The type of this resource.
|
void |
setRestrictScimSearch(java.lang.Boolean restrictScimSearch)
If set to true, then it is only possible to perform a SCIM search against the
OIDC provider used to authenticate.
|
void |
setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource.
|
void |
setSchema(java.lang.String schema)
Schema for this resource
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
void |
setScimEndpoints(java.util.List<java.lang.String> scimEndpoints)
The SCIM (System for Cross-domain Identity Management) endpoint URLs to use when
enumerating users and groups.
|
void |
setSelf(SelfResourceLink self) |
void |
setServicedDomains(java.util.List<java.lang.String> servicedDomains)
When a login to NSX using a principal name of the form user@domain is attempted,
the list of OIDC providers will be scanned to find one with a matching domain.
|
void |
setSystemOwned(java.lang.Boolean systemOwned)
Indicates system owned resource
This property may be present in responses from the server, but if it is present
in a request to server it will be ignored.
|
void |
setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user
|
void |
setThumbprint(java.lang.String thumbprint)
Thumbprint in SHA-256 format used to verify the server certificate at the URI.
|
void |
setTokenEndpoint(java.lang.String tokenEndpoint)
The URL of the OpenID provider's token endpoint.
|
void |
setUserinfoEndpoint(java.lang.String userinfoEndpoint)
The URL of the OpenID provider's userinfo endpoint.
|
java.lang.String |
toString() |
public static final java.lang.String OIDC_TYPE_VCENTER
public static final java.lang.String OIDC_TYPE_WS_ONE
public static final java.lang.String OIDC_TYPE_CSP
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
public OidcEndPoint()
protected OidcEndPoint(com.vmware.vapi.data.StructValue __dynamicStructureFields)
public java.util.List<ResourceLink> getLinks()
public void setLinks(java.util.List<ResourceLink> links)
links
- New value for the property.public java.lang.String getSchema()
public void setSchema(java.lang.String schema)
schema
- New value for the property.public SelfResourceLink getSelf()
public void setSelf(SelfResourceLink self)
self
- New value for the property.public java.lang.Long getRevision()
public void setRevision(java.lang.Long revision)
revision
- New value for the property.public java.lang.Long getCreateTime()
public void setCreateTime(java.lang.Long createTime)
createTime
- New value for the property.public java.lang.String getCreateUser()
public void setCreateUser(java.lang.String createUser)
createUser
- New value for the property.public java.lang.Long getLastModifiedTime()
public void setLastModifiedTime(java.lang.Long lastModifiedTime)
lastModifiedTime
- New value for the property.public java.lang.String getLastModifiedUser()
public void setLastModifiedUser(java.lang.String lastModifiedUser)
lastModifiedUser
- New value for the property.public java.lang.String getProtection()
public void setProtection(java.lang.String protection)
protection
- New value for the property.public java.lang.Boolean getSystemOwned()
public void setSystemOwned(java.lang.Boolean systemOwned)
systemOwned
- New value for the property.public java.lang.String getDescription()
public void setDescription(java.lang.String description)
description
- New value for the property.public java.lang.String getDisplayName()
public void setDisplayName(java.lang.String displayName)
displayName
- New value for the property.public java.lang.String getId()
public void setId(java.lang.String id)
id
- New value for the property.public java.lang.String getResourceType()
public void setResourceType(java.lang.String resourceType)
resourceType
- New value for the property.public java.util.List<Tag> getTags()
public void setTags(java.util.List<Tag> tags)
tags
- New value for the property.public java.lang.String getAuthorizationEndpoint()
public void setAuthorizationEndpoint(java.lang.String authorizationEndpoint)
authorizationEndpoint
- New value for the property.public java.util.List<ClaimMap> getClaimMap()
public void setClaimMap(java.util.List<ClaimMap> claimMap)
claimMap
- New value for the property.public java.util.List<java.lang.String> getClaimsSupported()
public void setClaimsSupported(java.util.List<java.lang.String> claimsSupported)
claimsSupported
- New value for the property.public java.lang.String getClientId()
public void setClientId(java.lang.String clientId)
clientId
- New value for the property.public java.lang.String getClientSecret()
public void setClientSecret(java.lang.String clientSecret)
clientSecret
- New value for the property.public CspConfig getCspConfig()
public void setCspConfig(CspConfig cspConfig)
cspConfig
- New value for the property.public java.lang.String getEndSessionEndpointUri()
public void setEndSessionEndpointUri(java.lang.String endSessionEndpointUri)
endSessionEndpointUri
- New value for the property.public java.lang.String getIssuer()
public void setIssuer(java.lang.String issuer)
issuer
- New value for the property.public java.lang.String getJwksUri()
public void setJwksUri(java.lang.String jwksUri)
jwksUri
- New value for the property.public java.lang.String getName()
public void setName(java.lang.String name)
name
- New value for the property.public java.lang.String getOidcType()
public void setOidcType(java.lang.String oidcType)
oidcType
- New value for the property.public java.lang.String getOidcUri()
public void setOidcUri(java.lang.String oidcUri)
oidcUri
- New value for the property.public java.util.List<java.lang.String> getOverrideRoles()
public void setOverrideRoles(java.util.List<java.lang.String> overrideRoles)
overrideRoles
- New value for the property.public java.lang.Boolean getRestrictScimSearch()
public void setRestrictScimSearch(java.lang.Boolean restrictScimSearch)
restrictScimSearch
- New value for the property.public java.util.List<java.lang.String> getScimEndpoints()
public void setScimEndpoints(java.util.List<java.lang.String> scimEndpoints)
scimEndpoints
- New value for the property.public java.util.List<java.lang.String> getServicedDomains()
public void setServicedDomains(java.util.List<java.lang.String> servicedDomains)
servicedDomains
- New value for the property.public java.lang.String getThumbprint()
public void setThumbprint(java.lang.String thumbprint)
thumbprint
- New value for the property.public java.lang.String getTokenEndpoint()
public void setTokenEndpoint(java.lang.String tokenEndpoint)
tokenEndpoint
- New value for the property.public java.lang.String getUserinfoEndpoint()
public void setUserinfoEndpoint(java.lang.String userinfoEndpoint)
userinfoEndpoint
- New value for the property.public com.vmware.vapi.bindings.type.StructType _getType()
_getType
in interface com.vmware.vapi.bindings.StaticStructure
public com.vmware.vapi.data.StructValue _getDataValue()
_getDataValue
in interface com.vmware.vapi.bindings.Structure
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
public void _validate()
_validate
in interface com.vmware.vapi.bindings.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()
toString
in interface com.vmware.vapi.bindings.StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
_hasTypeNameOf
in interface com.vmware.vapi.bindings.Structure
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
_convertTo
in interface com.vmware.vapi.bindings.Structure
public void _setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
_setDynamicField
in interface com.vmware.vapi.bindings.StaticStructure
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
_getDynamicField
in interface com.vmware.vapi.bindings.StaticStructure
public java.util.Set<java.lang.String> _getDynamicFieldNames()
_getDynamicFieldNames
in interface com.vmware.vapi.bindings.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()
_getCanonicalName
in interface com.vmware.vapi.bindings.Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static OidcEndPoint _newInstance(com.vmware.vapi.data.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 OidcEndPoint _newInstance2(com.vmware.vapi.data.StructValue structValue)