public static final class OidcEndPoint.Builder
extends java.lang.Object
OidcEndPoint
.Constructor and Description |
---|
Builder()
Constructor with parameters for the required properties of
OidcEndPoint . |
Modifier and Type | Method and Description |
---|---|
OidcEndPoint |
build() |
OidcEndPoint.Builder |
setAuthorizationEndpoint(java.lang.String authorizationEndpoint)
The URL of the OpenID provider's authorization endpoint.
|
OidcEndPoint.Builder |
setClaimMap(java.util.List<ClaimMap> claimMap)
Configuration for mapping claims in OIDC ID tokens to NSX roles.
|
OidcEndPoint.Builder |
setClaimsSupported(java.util.List<java.lang.String> claimsSupported)
The list of claims that the OpenID provider supports.
|
OidcEndPoint.Builder |
setClientId(java.lang.String clientId)
The client ID for NSX to use when authenticating via this OIDC provider.
|
OidcEndPoint.Builder |
setClientSecret(java.lang.String clientSecret)
The client secret for NSX to use when authenticating via this OIDC provider.
|
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
setCspConfig(CspConfig cspConfig) |
OidcEndPoint.Builder |
setDescription(java.lang.String description)
Description of this resource
|
OidcEndPoint.Builder |
setDisplayName(java.lang.String displayName)
Defaults to ID if not set
|
OidcEndPoint.Builder |
setEndSessionEndpointUri(java.lang.String endSessionEndpointUri)
URI of the OpenID session logout end-point.
|
OidcEndPoint.Builder |
setId(java.lang.String id)
Unique identifier of this resource
|
OidcEndPoint.Builder |
setIssuer(java.lang.String issuer)
Issuer of the JWT tokens for the given type.
|
OidcEndPoint.Builder |
setJwksUri(java.lang.String jwksUri)
The URI where the JWKS document is located that has the key used to validate the
JWT signature.
|
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.
|
OidcEndPoint.Builder |
setName(java.lang.String name)
A short, unique name for this OpenID Connect end-point.
|
OidcEndPoint.Builder |
setOidcType(java.lang.String oidcType)
Possible values are:
OidcEndPoint.OIDC_TYPE_VCENTER OidcEndPoint.OIDC_TYPE_WS_ONE OidcEndPoint.OIDC_TYPE_CSP Type used to
distinguish the OIDC end-points by IDP. |
OidcEndPoint.Builder |
setOidcUri(java.lang.String oidcUri)
URI of the OpenID Connect end-point.
|
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
setResourceType(java.lang.String resourceType)
The type of this resource.
|
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource.
|
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
setSelf(SelfResourceLink self) |
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
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.
|
OidcEndPoint.Builder |
setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user
|
OidcEndPoint.Builder |
setThumbprint(java.lang.String thumbprint)
Thumbprint in SHA-256 format used to verify the server certificate at the URI.
|
OidcEndPoint.Builder |
setTokenEndpoint(java.lang.String tokenEndpoint)
The URL of the OpenID provider's token endpoint.
|
OidcEndPoint.Builder |
setUserinfoEndpoint(java.lang.String userinfoEndpoint)
The URL of the OpenID provider's userinfo endpoint.
|
public Builder()
OidcEndPoint
.public OidcEndPoint.Builder setLinks(java.util.List<ResourceLink> links)
links
- New value for the property.public OidcEndPoint.Builder setSchema(java.lang.String schema)
schema
- New value for the property.public OidcEndPoint.Builder setSelf(SelfResourceLink self)
self
- New value for the property.public OidcEndPoint.Builder setRevision(java.lang.Long revision)
revision
- New value for the property.public OidcEndPoint.Builder setCreateTime(java.lang.Long createTime)
createTime
- New value for the property.public OidcEndPoint.Builder setCreateUser(java.lang.String createUser)
createUser
- New value for the property.public OidcEndPoint.Builder setLastModifiedTime(java.lang.Long lastModifiedTime)
lastModifiedTime
- New value for the property.public OidcEndPoint.Builder setLastModifiedUser(java.lang.String lastModifiedUser)
lastModifiedUser
- New value for the property.public OidcEndPoint.Builder setProtection(java.lang.String protection)
protection
- New value for the property.public OidcEndPoint.Builder setSystemOwned(java.lang.Boolean systemOwned)
systemOwned
- New value for the property.public OidcEndPoint.Builder setDescription(java.lang.String description)
description
- New value for the property.public OidcEndPoint.Builder setDisplayName(java.lang.String displayName)
displayName
- New value for the property.public OidcEndPoint.Builder setId(java.lang.String id)
id
- New value for the property.public OidcEndPoint.Builder setResourceType(java.lang.String resourceType)
resourceType
- New value for the property.public OidcEndPoint.Builder setTags(java.util.List<Tag> tags)
tags
- New value for the property.public OidcEndPoint.Builder setAuthorizationEndpoint(java.lang.String authorizationEndpoint)
authorizationEndpoint
- New value for the property.public OidcEndPoint.Builder setClaimMap(java.util.List<ClaimMap> claimMap)
claimMap
- New value for the property.public OidcEndPoint.Builder setClaimsSupported(java.util.List<java.lang.String> claimsSupported)
claimsSupported
- New value for the property.public OidcEndPoint.Builder setClientId(java.lang.String clientId)
clientId
- New value for the property.public OidcEndPoint.Builder setClientSecret(java.lang.String clientSecret)
clientSecret
- New value for the property.public OidcEndPoint.Builder setCspConfig(CspConfig cspConfig)
cspConfig
- New value for the property.public OidcEndPoint.Builder setEndSessionEndpointUri(java.lang.String endSessionEndpointUri)
endSessionEndpointUri
- New value for the property.public OidcEndPoint.Builder setIssuer(java.lang.String issuer)
issuer
- New value for the property.public OidcEndPoint.Builder setJwksUri(java.lang.String jwksUri)
jwksUri
- New value for the property.public OidcEndPoint.Builder setName(java.lang.String name)
name
- New value for the property.public OidcEndPoint.Builder setOidcType(java.lang.String oidcType)
oidcType
- New value for the property.public OidcEndPoint.Builder setOidcUri(java.lang.String oidcUri)
oidcUri
- New value for the property.public OidcEndPoint.Builder setOverrideRoles(java.util.List<java.lang.String> overrideRoles)
overrideRoles
- New value for the property.public OidcEndPoint.Builder setRestrictScimSearch(java.lang.Boolean restrictScimSearch)
restrictScimSearch
- New value for the property.public OidcEndPoint.Builder setScimEndpoints(java.util.List<java.lang.String> scimEndpoints)
scimEndpoints
- New value for the property.public OidcEndPoint.Builder setServicedDomains(java.util.List<java.lang.String> servicedDomains)
servicedDomains
- New value for the property.public OidcEndPoint.Builder setThumbprint(java.lang.String thumbprint)
thumbprint
- New value for the property.public OidcEndPoint.Builder setTokenEndpoint(java.lang.String tokenEndpoint)
tokenEndpoint
- New value for the property.public OidcEndPoint.Builder setUserinfoEndpoint(java.lang.String userinfoEndpoint)
userinfoEndpoint
- New value for the property.public OidcEndPoint build()