com.vmware.avi.sdk.model.OAuthProfile Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of avisdk Show documentation
Show all versions of avisdk Show documentation
Avi SDK is a java API which creates a session with controller and perform CRUD operations.
The newest version!
/*
* Copyright 2021 VMware, Inc.
* SPDX-License-Identifier: Apache License 2.0
*/
package com.vmware.avi.sdk.model;
import java.util.*;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonInclude;
/**
* The OAuthProfile is a POJO class extends AviRestResource that used for creating
* OAuthProfile.
*
* @version 1.0
* @since
*
*/
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonInclude(JsonInclude.Include.NON_NULL)
public class OAuthProfile {
@JsonProperty("authorization_endpoint")
private String authorizationEndpoint;
@JsonProperty("end_session_endpoint")
private String endSessionEndpoint;
@JsonProperty("instance_id")
private String instanceId;
@JsonProperty("introspection_endpoint")
private String introspectionEndpoint;
@JsonProperty("issuer")
private String issuer;
@JsonProperty("jwks_timeout")
private Integer jwksTimeout = 0;
@JsonProperty("jwks_uri")
private String jwksUri;
@JsonProperty("oauth_controller_settings")
private OAuthAppSettings oauthControllerSettings;
@JsonProperty("oauth_profile_type")
private String oauthProfileType = "CLIENT_OAUTH";
@JsonProperty("oauth_provider")
private String oauthProvider;
@JsonProperty("oauth_resp_buffer_sz")
private Integer oauthRespBufferSz = 102400;
@JsonProperty("org_id")
private String orgId;
@JsonProperty("pool_ref")
private String poolRef;
@JsonProperty("redirect_uri")
private String redirectUri;
@JsonProperty("service_id")
private String serviceId;
@JsonProperty("service_name")
private String serviceName;
@JsonProperty("token_endpoint")
private String tokenEndpoint;
@JsonProperty("userinfo_endpoint")
private String userinfoEndpoint;
/**
* This is the getter method this will return the attribute value.
* Url of authorization server.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return authorizationEndpoint
*/
public String getAuthorizationEndpoint() {
return authorizationEndpoint;
}
/**
* This is the setter method to the attribute.
* Url of authorization server.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param authorizationEndpoint set the authorizationEndpoint.
*/
public void setAuthorizationEndpoint(String authorizationEndpoint) {
this.authorizationEndpoint = authorizationEndpoint;
}
/**
* This is the getter method this will return the attribute value.
* Logout uri of idp server.
* Field introduced in 22.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return endSessionEndpoint
*/
public String getEndSessionEndpoint() {
return endSessionEndpoint;
}
/**
* This is the setter method to the attribute.
* Logout uri of idp server.
* Field introduced in 22.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param endSessionEndpoint set the endSessionEndpoint.
*/
public void setEndSessionEndpoint(String endSessionEndpoint) {
this.endSessionEndpoint = endSessionEndpoint;
}
/**
* This is the getter method this will return the attribute value.
* Instance uuid of the csp service.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return instanceId
*/
public String getInstanceId() {
return instanceId;
}
/**
* This is the setter method to the attribute.
* Instance uuid of the csp service.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param instanceId set the instanceId.
*/
public void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
/**
* This is the getter method this will return the attribute value.
* Url of token introspection server.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return introspectionEndpoint
*/
public String getIntrospectionEndpoint() {
return introspectionEndpoint;
}
/**
* This is the setter method to the attribute.
* Url of token introspection server.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param introspectionEndpoint set the introspectionEndpoint.
*/
public void setIntrospectionEndpoint(String introspectionEndpoint) {
this.introspectionEndpoint = introspectionEndpoint;
}
/**
* This is the getter method this will return the attribute value.
* Uniquely identifiable name of the token issuer.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return issuer
*/
public String getIssuer() {
return issuer;
}
/**
* This is the setter method to the attribute.
* Uniquely identifiable name of the token issuer.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param issuer set the issuer.
*/
public void setIssuer(String issuer) {
this.issuer = issuer;
}
/**
* This is the getter method this will return the attribute value.
* Lifetime of the cached jwks keys.
* Allowed values are 0-1440.
* Field introduced in 21.1.3.
* Unit is min.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as 0.
* @return jwksTimeout
*/
public Integer getJwksTimeout() {
return jwksTimeout;
}
/**
* This is the setter method to the attribute.
* Lifetime of the cached jwks keys.
* Allowed values are 0-1440.
* Field introduced in 21.1.3.
* Unit is min.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as 0.
* @param jwksTimeout set the jwksTimeout.
*/
public void setJwksTimeout(Integer jwksTimeout) {
this.jwksTimeout = jwksTimeout;
}
/**
* This is the getter method this will return the attribute value.
* Jwks url of the endpoint that hosts the public keys that can be used to verify any jwt issued by the authorization server.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return jwksUri
*/
public String getJwksUri() {
return jwksUri;
}
/**
* This is the setter method to the attribute.
* Jwks url of the endpoint that hosts the public keys that can be used to verify any jwt issued by the authorization server.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param jwksUri set the jwksUri.
*/
public void setJwksUri(String jwksUri) {
this.jwksUri = jwksUri;
}
/**
* This is the getter method this will return the attribute value.
* Oauth app settings for controller authentication.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return oauthControllerSettings
*/
public OAuthAppSettings getOauthControllerSettings() {
return oauthControllerSettings;
}
/**
* This is the setter method to the attribute.
* Oauth app settings for controller authentication.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param oauthControllerSettings set the oauthControllerSettings.
*/
public void setOauthControllerSettings(OAuthAppSettings oauthControllerSettings) {
this.oauthControllerSettings = oauthControllerSettings;
}
/**
* This is the getter method this will return the attribute value.
* Type of oauth profile which defines the usage type.
* Enum options - CLIENT_OAUTH, CONTROLLER_OAUTH.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as "CLIENT_OAUTH".
* @return oauthProfileType
*/
public String getOauthProfileType() {
return oauthProfileType;
}
/**
* This is the setter method to the attribute.
* Type of oauth profile which defines the usage type.
* Enum options - CLIENT_OAUTH, CONTROLLER_OAUTH.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as "CLIENT_OAUTH".
* @param oauthProfileType set the oauthProfileType.
*/
public void setOauthProfileType(String oauthProfileType) {
this.oauthProfileType = oauthProfileType;
}
/**
* This is the getter method this will return the attribute value.
* Type of oauth provider when using controller oauth as oauth profile type.
* Enum options - OAUTH_CSP.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return oauthProvider
*/
public String getOauthProvider() {
return oauthProvider;
}
/**
* This is the setter method to the attribute.
* Type of oauth provider when using controller oauth as oauth profile type.
* Enum options - OAUTH_CSP.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param oauthProvider set the oauthProvider.
*/
public void setOauthProvider(String oauthProvider) {
this.oauthProvider = oauthProvider;
}
/**
* This is the getter method this will return the attribute value.
* Buffering size for the responses from the oauth enpoints.
* Allowed values are 0-32768000.
* Field introduced in 21.1.3.
* Unit is bytes.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as 102400.
* @return oauthRespBufferSz
*/
public Integer getOauthRespBufferSz() {
return oauthRespBufferSz;
}
/**
* This is the setter method to the attribute.
* Buffering size for the responses from the oauth enpoints.
* Allowed values are 0-32768000.
* Field introduced in 21.1.3.
* Unit is bytes.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as 102400.
* @param oauthRespBufferSz set the oauthRespBufferSz.
*/
public void setOauthRespBufferSz(Integer oauthRespBufferSz) {
this.oauthRespBufferSz = oauthRespBufferSz;
}
/**
* This is the getter method this will return the attribute value.
* Organization id for oauth.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return orgId
*/
public String getOrgId() {
return orgId;
}
/**
* This is the setter method to the attribute.
* Organization id for oauth.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param orgId set the orgId.
*/
public void setOrgId(String orgId) {
this.orgId = orgId;
}
/**
* This is the getter method this will return the attribute value.
* Pool object to interface with authorization server endpoints.
* It is a reference to an object of type pool.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return poolRef
*/
public String getPoolRef() {
return poolRef;
}
/**
* This is the setter method to the attribute.
* Pool object to interface with authorization server endpoints.
* It is a reference to an object of type pool.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param poolRef set the poolRef.
*/
public void setPoolRef(String poolRef) {
this.poolRef = poolRef;
}
/**
* This is the getter method this will return the attribute value.
* Redirect uri specified in the request to authorization server.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return redirectUri
*/
public String getRedirectUri() {
return redirectUri;
}
/**
* This is the setter method to the attribute.
* Redirect uri specified in the request to authorization server.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param redirectUri set the redirectUri.
*/
public void setRedirectUri(String redirectUri) {
this.redirectUri = redirectUri;
}
/**
* This is the getter method this will return the attribute value.
* Uuid value of csp service.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return serviceId
*/
public String getServiceId() {
return serviceId;
}
/**
* This is the setter method to the attribute.
* Uuid value of csp service.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param serviceId set the serviceId.
*/
public void setServiceId(String serviceId) {
this.serviceId = serviceId;
}
/**
* This is the getter method this will return the attribute value.
* Name of the csp service.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return serviceName
*/
public String getServiceName() {
return serviceName;
}
/**
* This is the setter method to the attribute.
* Name of the csp service.
* Field introduced in 30.1.1.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param serviceName set the serviceName.
*/
public void setServiceName(String serviceName) {
this.serviceName = serviceName;
}
/**
* This is the getter method this will return the attribute value.
* Url of token exchange server.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return tokenEndpoint
*/
public String getTokenEndpoint() {
return tokenEndpoint;
}
/**
* This is the setter method to the attribute.
* Url of token exchange server.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param tokenEndpoint set the tokenEndpoint.
*/
public void setTokenEndpoint(String tokenEndpoint) {
this.tokenEndpoint = tokenEndpoint;
}
/**
* This is the getter method this will return the attribute value.
* Url of the userinfo endpoint.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @return userinfoEndpoint
*/
public String getUserinfoEndpoint() {
return userinfoEndpoint;
}
/**
* This is the setter method to the attribute.
* Url of the userinfo endpoint.
* Field introduced in 21.1.3.
* Allowed in enterprise edition with any value, enterprise with cloud services edition.
* Default value when not specified in API or module is interpreted by Avi Controller as null.
* @param userinfoEndpoint set the userinfoEndpoint.
*/
public void setUserinfoEndpoint(String userinfoEndpoint) {
this.userinfoEndpoint = userinfoEndpoint;
}
@Override
public boolean equals(java.lang.Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
OAuthProfile objOAuthProfile = (OAuthProfile) o;
return Objects.equals(this.authorizationEndpoint, objOAuthProfile.authorizationEndpoint)&&
Objects.equals(this.tokenEndpoint, objOAuthProfile.tokenEndpoint)&&
Objects.equals(this.introspectionEndpoint, objOAuthProfile.introspectionEndpoint)&&
Objects.equals(this.jwksUri, objOAuthProfile.jwksUri)&&
Objects.equals(this.jwksTimeout, objOAuthProfile.jwksTimeout)&&
Objects.equals(this.issuer, objOAuthProfile.issuer)&&
Objects.equals(this.poolRef, objOAuthProfile.poolRef)&&
Objects.equals(this.oauthRespBufferSz, objOAuthProfile.oauthRespBufferSz)&&
Objects.equals(this.userinfoEndpoint, objOAuthProfile.userinfoEndpoint)&&
Objects.equals(this.endSessionEndpoint, objOAuthProfile.endSessionEndpoint)&&
Objects.equals(this.redirectUri, objOAuthProfile.redirectUri)&&
Objects.equals(this.orgId, objOAuthProfile.orgId)&&
Objects.equals(this.oauthProfileType, objOAuthProfile.oauthProfileType)&&
Objects.equals(this.oauthControllerSettings, objOAuthProfile.oauthControllerSettings)&&
Objects.equals(this.oauthProvider, objOAuthProfile.oauthProvider)&&
Objects.equals(this.serviceId, objOAuthProfile.serviceId)&&
Objects.equals(this.instanceId, objOAuthProfile.instanceId)&&
Objects.equals(this.serviceName, objOAuthProfile.serviceName);
}
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("class OAuthProfile {\n");
sb.append(" authorizationEndpoint: ").append(toIndentedString(authorizationEndpoint)).append("\n");
sb.append(" endSessionEndpoint: ").append(toIndentedString(endSessionEndpoint)).append("\n");
sb.append(" instanceId: ").append(toIndentedString(instanceId)).append("\n");
sb.append(" introspectionEndpoint: ").append(toIndentedString(introspectionEndpoint)).append("\n");
sb.append(" issuer: ").append(toIndentedString(issuer)).append("\n");
sb.append(" jwksTimeout: ").append(toIndentedString(jwksTimeout)).append("\n");
sb.append(" jwksUri: ").append(toIndentedString(jwksUri)).append("\n");
sb.append(" oauthControllerSettings: ").append(toIndentedString(oauthControllerSettings)).append("\n");
sb.append(" oauthProfileType: ").append(toIndentedString(oauthProfileType)).append("\n");
sb.append(" oauthProvider: ").append(toIndentedString(oauthProvider)).append("\n");
sb.append(" oauthRespBufferSz: ").append(toIndentedString(oauthRespBufferSz)).append("\n");
sb.append(" orgId: ").append(toIndentedString(orgId)).append("\n");
sb.append(" poolRef: ").append(toIndentedString(poolRef)).append("\n");
sb.append(" redirectUri: ").append(toIndentedString(redirectUri)).append("\n");
sb.append(" serviceId: ").append(toIndentedString(serviceId)).append("\n");
sb.append(" serviceName: ").append(toIndentedString(serviceName)).append("\n");
sb.append(" tokenEndpoint: ").append(toIndentedString(tokenEndpoint)).append("\n");
sb.append(" userinfoEndpoint: ").append(toIndentedString(userinfoEndpoint)).append("\n");
sb.append("}");
return sb.toString();
}
/**
* Convert the given object to string with each line indented by 4 spaces
* (except the first line).
*/
private String toIndentedString(java.lang.Object o) {
if (o == null) {
return "null";
}
return o.toString().replace("\n", "\n ");
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy