Share via

AuthorizationServerContractBaseProperties Class

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
  • java.lang.Object
    • com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties

public class AuthorizationServerContractBaseProperties

External OAuth authorization server Update settings contract.

Constructor Summary

Constructor Description
AuthorizationServerContractBaseProperties()

Method Summary

Modifier and Type Method and Description
java.util.List<AuthorizationMethod> authorizationMethods()

Get hTTP verbs supported by the authorization endpoint.
java.util.List<BearerTokenSendingMethod> bearerTokenSendingMethods()

Get specifies the mechanism by which access token is passed to the API.
java.util.List<ClientAuthenticationMethod> clientAuthenticationMethod()

Get method of authentication supported by the token endpoint of this authorization server.
java.lang.String clientSecret()

Get client or app secret registered with this authorization server.
java.lang.String defaultScope()

Get access token scope that is going to be requested by default.
java.lang.String description()

Get description of the authorization server.
java.lang.String resourceOwnerPassword()

Get can be optionally specified when resource owner password grant type is supported by this authorization server.
java.lang.String resourceOwnerUsername()

Get can be optionally specified when resource owner password grant type is supported by this authorization server.
java.lang.Boolean supportState()

Get if true, authorization server will include state parameter from the authorization request to its response.
java.util.List<TokenBodyParameterContract> tokenBodyParameters()

Get 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.
java.lang.String tokenEndpoint()

Get oAuth token endpoint.
AuthorizationServerContractBaseProperties withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)

Set hTTP verbs supported by the authorization endpoint.
AuthorizationServerContractBaseProperties withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)

Set specifies the mechanism by which access token is passed to the API.
AuthorizationServerContractBaseProperties withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)

Set method of authentication supported by the token endpoint of this authorization server.
AuthorizationServerContractBaseProperties withClientSecret(String clientSecret)

Set client or app secret registered with this authorization server.
AuthorizationServerContractBaseProperties withDefaultScope(String defaultScope)

Set access token scope that is going to be requested by default.
AuthorizationServerContractBaseProperties withDescription(String description)

Set description of the authorization server.
AuthorizationServerContractBaseProperties withResourceOwnerPassword(String resourceOwnerPassword)

Set can be optionally specified when resource owner password grant type is supported by this authorization server.
AuthorizationServerContractBaseProperties withResourceOwnerUsername(String resourceOwnerUsername)

Set can be optionally specified when resource owner password grant type is supported by this authorization server.
AuthorizationServerContractBaseProperties withSupportState(Boolean supportState)

Set if true, authorization server will include state parameter from the authorization request to its response.
AuthorizationServerContractBaseProperties withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)

Set 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.
AuthorizationServerContractBaseProperties withTokenEndpoint(String tokenEndpoint)

Set oAuth token endpoint.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

AuthorizationServerContractBaseProperties

public AuthorizationServerContractBaseProperties()

Method Details

authorizationMethods

public List<AuthorizationMethod> authorizationMethods()

Get hTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.

Returns:

the authorizationMethods value

bearerTokenSendingMethods

public List<BearerTokenSendingMethod> bearerTokenSendingMethods()

Get specifies the mechanism by which access token is passed to the API.

Returns:

the bearerTokenSendingMethods value

clientAuthenticationMethod

public List<ClientAuthenticationMethod> clientAuthenticationMethod()

Get 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.

Returns:

the clientAuthenticationMethod value

clientSecret

public String clientSecret()

Get client or app secret registered with this authorization server.

Returns:

the clientSecret value

defaultScope

public String defaultScope()

Get 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.

Returns:

the defaultScope value

description

public String description()

Get description of the authorization server. Can contain HTML formatting tags.

Returns:

the description value

resourceOwnerPassword

public String resourceOwnerPassword()

Get can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

Returns:

the resourceOwnerPassword value

resourceOwnerUsername

public String resourceOwnerUsername()

Get can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.

Returns:

the resourceOwnerUsername value

supportState

public Boolean supportState()

Get if true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.

Returns:

the supportState value

tokenBodyParameters

public List<TokenBodyParameterContract> tokenBodyParameters()

Get 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"}.

Returns:

the tokenBodyParameters value

tokenEndpoint

public String tokenEndpoint()

Get oAuth token endpoint. Contains absolute URI to entity being referenced.

Returns:

the tokenEndpoint value

withAuthorizationMethods

public AuthorizationServerContractBaseProperties withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)

Set hTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.

Parameters:

authorizationMethods - the authorizationMethods value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

withBearerTokenSendingMethods

public AuthorizationServerContractBaseProperties withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)

Set specifies the mechanism by which access token is passed to the API.

Parameters:

bearerTokenSendingMethods - the bearerTokenSendingMethods value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

withClientAuthenticationMethod

public AuthorizationServerContractBaseProperties withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)

Set 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.

Parameters:

clientAuthenticationMethod - the clientAuthenticationMethod value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

withClientSecret

public AuthorizationServerContractBaseProperties withClientSecret(String clientSecret)

Set client or app secret registered with this authorization server.

Parameters:

clientSecret - the clientSecret value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

withDefaultScope

public AuthorizationServerContractBaseProperties withDefaultScope(String defaultScope)

Set 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.

Parameters:

defaultScope - the defaultScope value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

withDescription

public AuthorizationServerContractBaseProperties withDescription(String description)

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

Parameters:

description - the description value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

withResourceOwnerPassword

public AuthorizationServerContractBaseProperties withResourceOwnerPassword(String resourceOwnerPassword)

Set can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

Parameters:

resourceOwnerPassword - the resourceOwnerPassword value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

withResourceOwnerUsername

public AuthorizationServerContractBaseProperties withResourceOwnerUsername(String resourceOwnerUsername)

Set can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.

Parameters:

resourceOwnerUsername - the resourceOwnerUsername value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

withSupportState

public AuthorizationServerContractBaseProperties withSupportState(Boolean supportState)

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

Parameters:

supportState - the supportState value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

withTokenBodyParameters

public AuthorizationServerContractBaseProperties withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)

Set 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"}.

Parameters:

tokenBodyParameters - the tokenBodyParameters value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

withTokenEndpoint

public AuthorizationServerContractBaseProperties withTokenEndpoint(String tokenEndpoint)

Set oAuth token endpoint. Contains absolute URI to entity being referenced.

Parameters:

tokenEndpoint - the tokenEndpoint value to set

Returns:

the AuthorizationServerContractBaseProperties object itself.

Applies to