Package com.azure.resourcemanager.apimanagement.models

Class AuthorizationServerContractBaseProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.models.AuthorizationServerContractBaseProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<AuthorizationServerContractBaseProperties>
Direct Known Subclasses:
AuthorizationServerContractProperties, AuthorizationServerUpdateContractProperties
public class AuthorizationServerContractBaseProperties extends Object implements com.azure.json.JsonSerializable<AuthorizationServerContractBaseProperties>
External OAuth authorization server Update settings contract.

  • Constructor Details

    • AuthorizationServerContractBaseProperties

      public AuthorizationServerContractBaseProperties()
      Creates an instance of AuthorizationServerContractBaseProperties class.

  • Method Details

    • description

      public String description()
      Get the description property: Description of the authorization server. Can contain HTML formatting tags.
      Returns:
      the description value.

    • withDescription

      public AuthorizationServerContractBaseProperties withDescription(String description)
      Set the description property: Description of the authorization server. Can contain HTML formatting tags.
      Parameters:
      description - the description value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • authorizationMethods

      public List<AuthorizationMethod> authorizationMethods()
      Get the authorizationMethods property: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
      Returns:
      the authorizationMethods value.

    • withAuthorizationMethods

      public AuthorizationServerContractBaseProperties withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)
      Set the authorizationMethods property: 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.

    • clientAuthenticationMethod

      public List<ClientAuthenticationMethod> clientAuthenticationMethod()
      Get 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.
      Returns:
      the clientAuthenticationMethod value.

    • withClientAuthenticationMethod

      public AuthorizationServerContractBaseProperties 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.
      Parameters:
      clientAuthenticationMethod - the clientAuthenticationMethod value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • tokenBodyParameters

      public List<TokenBodyParameterContract> tokenBodyParameters()
      Get 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"}.
      Returns:
      the tokenBodyParameters value.

    • withTokenBodyParameters

      public AuthorizationServerContractBaseProperties 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"}.
      Parameters:
      tokenBodyParameters - the tokenBodyParameters value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • tokenEndpoint

      public String tokenEndpoint()
      Get the tokenEndpoint property: OAuth token endpoint. Contains absolute URI to entity being referenced.
      Returns:
      the tokenEndpoint value.

    • withTokenEndpoint

      public AuthorizationServerContractBaseProperties withTokenEndpoint(String tokenEndpoint)
      Set the tokenEndpoint property: OAuth token endpoint. Contains absolute URI to entity being referenced.
      Parameters:
      tokenEndpoint - the tokenEndpoint value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • supportState

      public Boolean supportState()
      Get 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.
      Returns:
      the supportState value.

    • withSupportState

      public AuthorizationServerContractBaseProperties 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.
      Parameters:
      supportState - the supportState value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • defaultScope

      public String defaultScope()
      Get 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.
      Returns:
      the defaultScope value.

    • withDefaultScope

      public AuthorizationServerContractBaseProperties 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.
      Parameters:
      defaultScope - the defaultScope value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • bearerTokenSendingMethods

      public List<BearerTokenSendingMethod> bearerTokenSendingMethods()
      Get the bearerTokenSendingMethods property: Specifies the mechanism by which access token is passed to the API.
      Returns:
      the bearerTokenSendingMethods value.

    • withBearerTokenSendingMethods

      public AuthorizationServerContractBaseProperties withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)
      Set the bearerTokenSendingMethods property: Specifies the mechanism by which access token is passed to the API.
      Parameters:
      bearerTokenSendingMethods - the bearerTokenSendingMethods value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • resourceOwnerUsername

      public String resourceOwnerUsername()
      Get the resourceOwnerUsername property: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
      Returns:
      the resourceOwnerUsername value.

    • withResourceOwnerUsername

      public AuthorizationServerContractBaseProperties 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.
      Parameters:
      resourceOwnerUsername - the resourceOwnerUsername value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • resourceOwnerPassword

      public String resourceOwnerPassword()
      Get the resourceOwnerPassword property: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
      Returns:
      the resourceOwnerPassword value.

    • withResourceOwnerPassword

      public AuthorizationServerContractBaseProperties 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.
      Parameters:
      resourceOwnerPassword - the resourceOwnerPassword value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<AuthorizationServerContractBaseProperties>
      Throws:
      IOException

    • fromJson

      public static AuthorizationServerContractBaseProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AuthorizationServerContractBaseProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AuthorizationServerContractBaseProperties 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 AuthorizationServerContractBaseProperties.