AuthorizationServerUpdateContractProperties Class

Package:

com.azure.resourcemanager.apimanagement.fluent.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-apimanagement:2.0.0

• java.lang.Object
• • com.azure.resourcemanager.apimanagement.models.AuthorizationServerContractBaseProperties
  • • com.azure.resourcemanager.apimanagement.fluent.models.AuthorizationServerUpdateContractProperties

public final class AuthorizationServerUpdateContractProperties
extends AuthorizationServerContractBaseProperties

External OAuth authorization server Update settings contract.

Constructor Summary

Constructor	Description
AuthorizationServerUpdateContractProperties()	Creates an instance of AuthorizationServerUpdateContractProperties class.

Method Summary

Modifier and Type	Method and Description
String	authorizationEndpoint() Get the authorizationEndpoint property: OAuth authorization endpoint.
String	clientId() Get the clientId property: Client or app id registered with this authorization server.
String	clientRegistrationEndpoint() Get the clientRegistrationEndpoint property: Optional reference to a page where client or app registration for this authorization server is performed.
String	clientSecret() Get the clientSecret property: Client or app secret registered with this authorization server.
String	displayName() Get the displayName property: User-friendly authorization server name.
static AuthorizationServerUpdateContractProperties	fromJson(JsonReader jsonReader) Reads an instance of AuthorizationServerUpdateContractProperties from the JsonReader.
List<GrantType>	grantTypes() Get the grantTypes property: Form of an authorization grant, which the client uses to request the access token.
JsonWriter	toJson(JsonWriter jsonWriter)
Boolean	useInApiDocumentation() Get the useInApiDocumentation property: If true, the authorization server will be used in the API documentation in the developer portal.
Boolean	useInTestConsole() Get the useInTestConsole property: If true, the authorization server may be used in the developer portal test console.
void	validate() Validates the instance.
AuthorizationServerUpdateContractProperties	withAuthorizationEndpoint(String authorizationEndpoint) Set the authorizationEndpoint property: OAuth authorization endpoint.
AuthorizationServerUpdateContractProperties	withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods) Set the authorizationMethods property: HTTP verbs supported by the authorization endpoint.
AuthorizationServerUpdateContractProperties	withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods) Set the bearerTokenSendingMethods property: Specifies the mechanism by which access token is passed to the API.
AuthorizationServerUpdateContractProperties	withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod) Set the clientAuthenticationMethod property: Method of authentication supported by the token endpoint of this authorization server.
AuthorizationServerUpdateContractProperties	withClientId(String clientId) Set the clientId property: Client or app id registered with this authorization server.
AuthorizationServerUpdateContractProperties	withClientRegistrationEndpoint(String clientRegistrationEndpoint) Set the clientRegistrationEndpoint property: Optional reference to a page where client or app registration for this authorization server is performed.
AuthorizationServerUpdateContractProperties	withClientSecret(String clientSecret) Set the clientSecret property: Client or app secret registered with this authorization server.
AuthorizationServerUpdateContractProperties	withDefaultScope(String defaultScope) Set the defaultScope property: Access token scope that is going to be requested by default.
AuthorizationServerUpdateContractProperties	withDescription(String description) Set the description property: Description of the authorization server.
AuthorizationServerUpdateContractProperties	withDisplayName(String displayName) Set the displayName property: User-friendly authorization server name.
AuthorizationServerUpdateContractProperties	withGrantTypes(List<GrantType> grantTypes) Set the grantTypes property: Form of an authorization grant, which the client uses to request the access token.
AuthorizationServerUpdateContractProperties	withResourceOwnerPassword(String resourceOwnerPassword) Set the resourceOwnerPassword property: Can be optionally specified when resource owner password grant type is supported by this authorization server.
AuthorizationServerUpdateContractProperties	withResourceOwnerUsername(String resourceOwnerUsername) Set the resourceOwnerUsername property: Can be optionally specified when resource owner password grant type is supported by this authorization server.
AuthorizationServerUpdateContractProperties	withSupportState(Boolean supportState) Set the supportState property: If true, authorization server will include state parameter from the authorization request to its response.
AuthorizationServerUpdateContractProperties	withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters) Set the tokenBodyParameters property: Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e.
AuthorizationServerUpdateContractProperties	withTokenEndpoint(String tokenEndpoint) Set the tokenEndpoint property: OAuth token endpoint.
AuthorizationServerUpdateContractProperties	withUseInApiDocumentation(Boolean useInApiDocumentation) Set the useInApiDocumentation property: If true, the authorization server will be used in the API documentation in the developer portal.
AuthorizationServerUpdateContractProperties	withUseInTestConsole(Boolean useInTestConsole) Set the useInTestConsole property: If true, the authorization server may be used in the developer portal test console.

Methods inherited from AuthorizationServerContractBaseProperties

authorizationMethods bearerTokenSendingMethods clientAuthenticationMethod defaultScope description fromJson resourceOwnerPassword resourceOwnerUsername supportState toJson tokenBodyParameters tokenEndpoint validate withAuthorizationMethods withBearerTokenSendingMethods withClientAuthenticationMethod withDefaultScope withDescription withResourceOwnerPassword withResourceOwnerUsername withSupportState withTokenBodyParameters withTokenEndpoint

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AuthorizationServerUpdateContractProperties

public AuthorizationServerUpdateContractProperties()

Creates an instance of AuthorizationServerUpdateContractProperties class.

Method Details

authorizationEndpoint

public String authorizationEndpoint()

Get the authorizationEndpoint property: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749\#section-3.2.

Returns:

the authorizationEndpoint value.

clientId

public String clientId()

Get the clientId property: Client or app id registered with this authorization server.

Returns:

the clientId value.

clientRegistrationEndpoint

public String clientRegistrationEndpoint()

Get the clientRegistrationEndpoint property: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.

Returns:

the clientRegistrationEndpoint value.

clientSecret

public String clientSecret()

Get the clientSecret property: Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

Returns:

the clientSecret value.

displayName

public String displayName()

Get the displayName property: User-friendly authorization server name.

Returns:

the displayName value.

fromJson

public static AuthorizationServerUpdateContractProperties fromJson(JsonReader jsonReader)

Reads an instance of AuthorizationServerUpdateContractProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AuthorizationServerUpdateContractProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the AuthorizationServerUpdateContractProperties.

grantTypes

public List<GrantType> grantTypes()

Get the grantTypes property: Form of an authorization grant, which the client uses to request the access token.

Returns:

the grantTypes value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

AuthorizationServerUpdateContractProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

useInApiDocumentation

public Boolean useInApiDocumentation()

Get the useInApiDocumentation property: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.

Returns:

the useInApiDocumentation value.

useInTestConsole

public Boolean useInTestConsole()

Get the useInTestConsole property: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.

Returns:

the useInTestConsole value.

validate

public void validate()

Validates the instance.

Overrides:

AuthorizationServerUpdateContractProperties.validate()

withAuthorizationEndpoint

public AuthorizationServerUpdateContractProperties withAuthorizationEndpoint(String authorizationEndpoint)

Set the authorizationEndpoint property: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749\#section-3.2.

Parameters:

authorizationEndpoint - the authorizationEndpoint value to set.

Returns:

the AuthorizationServerUpdateContractProperties object itself.

withAuthorizationMethods

public AuthorizationServerUpdateContractProperties withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)

Set the authorizationMethods property: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.

Overrides:

AuthorizationServerUpdateContractProperties.withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)

Parameters:

authorizationMethods

withBearerTokenSendingMethods

public AuthorizationServerUpdateContractProperties withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)

Set the bearerTokenSendingMethods property: Specifies the mechanism by which access token is passed to the API.

Overrides:

AuthorizationServerUpdateContractProperties.withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)

Parameters:

bearerTokenSendingMethods

withClientAuthenticationMethod

public AuthorizationServerUpdateContractProperties withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)

Set the clientAuthenticationMethod property: Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.

Overrides:

AuthorizationServerUpdateContractProperties.withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)

Parameters:

clientAuthenticationMethod

withClientId

public AuthorizationServerUpdateContractProperties withClientId(String clientId)

Set the clientId property: Client or app id registered with this authorization server.

Parameters:

clientId - the clientId value to set.

Returns:

the AuthorizationServerUpdateContractProperties object itself.

withClientRegistrationEndpoint

public AuthorizationServerUpdateContractProperties withClientRegistrationEndpoint(String clientRegistrationEndpoint)

Set the clientRegistrationEndpoint property: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.

Parameters:

clientRegistrationEndpoint - the clientRegistrationEndpoint value to set.

Returns:

the AuthorizationServerUpdateContractProperties object itself.

withClientSecret

public AuthorizationServerUpdateContractProperties withClientSecret(String clientSecret)

Set the clientSecret property: Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

Parameters:

clientSecret - the clientSecret value to set.

Returns:

the AuthorizationServerUpdateContractProperties object itself.

withDefaultScope

public AuthorizationServerUpdateContractProperties withDefaultScope(String defaultScope)

Set the defaultScope property: Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.

Overrides:

AuthorizationServerUpdateContractProperties.withDefaultScope(String defaultScope)

Parameters:

defaultScope

withDescription

public AuthorizationServerUpdateContractProperties withDescription(String description)

Set the description property: Description of the authorization server. Can contain HTML formatting tags.

Overrides:

AuthorizationServerUpdateContractProperties.withDescription(String description)

Parameters:

description

withDisplayName

public AuthorizationServerUpdateContractProperties withDisplayName(String displayName)

Set the displayName property: User-friendly authorization server name.

Parameters:

displayName - the displayName value to set.

Returns:

the AuthorizationServerUpdateContractProperties object itself.

withGrantTypes

public AuthorizationServerUpdateContractProperties withGrantTypes(List<GrantType> grantTypes)

Set the grantTypes property: Form of an authorization grant, which the client uses to request the access token.

Parameters:

grantTypes - the grantTypes value to set.

Returns:

the AuthorizationServerUpdateContractProperties object itself.

withResourceOwnerPassword

public AuthorizationServerUpdateContractProperties withResourceOwnerPassword(String resourceOwnerPassword)

Set the resourceOwnerPassword property: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

Overrides:

AuthorizationServerUpdateContractProperties.withResourceOwnerPassword(String resourceOwnerPassword)

Parameters:

resourceOwnerPassword

withResourceOwnerUsername

public AuthorizationServerUpdateContractProperties withResourceOwnerUsername(String resourceOwnerUsername)

Set the resourceOwnerUsername property: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.

Overrides:

AuthorizationServerUpdateContractProperties.withResourceOwnerUsername(String resourceOwnerUsername)

Parameters:

resourceOwnerUsername

withSupportState

public AuthorizationServerUpdateContractProperties withSupportState(Boolean supportState)

Set the supportState property: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.

Overrides:

AuthorizationServerUpdateContractProperties.withSupportState(Boolean supportState)

Parameters:

supportState

withTokenBodyParameters

public AuthorizationServerUpdateContractProperties withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)

Set the tokenBodyParameters property: Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.

Overrides:

AuthorizationServerUpdateContractProperties.withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)

Parameters:

tokenBodyParameters

withTokenEndpoint

public AuthorizationServerUpdateContractProperties withTokenEndpoint(String tokenEndpoint)

Set the tokenEndpoint property: OAuth token endpoint. Contains absolute URI to entity being referenced.

Overrides:

AuthorizationServerUpdateContractProperties.withTokenEndpoint(String tokenEndpoint)

Parameters:

tokenEndpoint

withUseInApiDocumentation

public AuthorizationServerUpdateContractProperties withUseInApiDocumentation(Boolean useInApiDocumentation)

Set the useInApiDocumentation property: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.

Parameters:

useInApiDocumentation - the useInApiDocumentation value to set.

Returns:

the AuthorizationServerUpdateContractProperties object itself.

withUseInTestConsole

public AuthorizationServerUpdateContractProperties withUseInTestConsole(Boolean useInTestConsole)

Set the useInTestConsole property: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.

Parameters:

useInTestConsole - the useInTestConsole value to set.

Returns:

the AuthorizationServerUpdateContractProperties object itself.