Package com.azure.resourcemanager.apimanagement.fluent.models

Class AuthorizationServerContractProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.models.AuthorizationServerContractBaseProperties
com.azure.resourcemanager.apimanagement.fluent.models.AuthorizationServerContractProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<AuthorizationServerContractBaseProperties>
public final class AuthorizationServerContractProperties extends AuthorizationServerContractBaseProperties
External OAuth authorization server settings Properties.

  • Constructor Details

    • AuthorizationServerContractProperties

      public AuthorizationServerContractProperties()
      Creates an instance of AuthorizationServerContractProperties class.

  • Method Details

    • displayName

      public String displayName()
      Get the displayName property: User-friendly authorization server name.
      Returns:
      the displayName value.

    • withDisplayName

      public AuthorizationServerContractProperties withDisplayName(String displayName)
      Set the displayName property: User-friendly authorization server name.
      Parameters:
      displayName - the displayName value to set.
      Returns:
      the AuthorizationServerContractProperties object itself.

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

    • withUseInTestConsole

      public AuthorizationServerContractProperties 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 AuthorizationServerContractProperties object itself.

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

    • withUseInApiDocumentation

      public AuthorizationServerContractProperties 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 AuthorizationServerContractProperties object itself.

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

    • withClientRegistrationEndpoint

      public AuthorizationServerContractProperties 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 AuthorizationServerContractProperties object itself.

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

    • withAuthorizationEndpoint

      public AuthorizationServerContractProperties 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 AuthorizationServerContractProperties object itself.

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

    • withGrantTypes

      public AuthorizationServerContractProperties 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 AuthorizationServerContractProperties object itself.

    • clientId

      public String clientId()
      Get the clientId property: Client or app id registered with this authorization server.
      Returns:
      the clientId value.

    • withClientId

      public AuthorizationServerContractProperties 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 AuthorizationServerContractProperties object itself.

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

    • withClientSecret

      public AuthorizationServerContractProperties 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 AuthorizationServerContractProperties object itself.

    • withDescription

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

    • withAuthorizationMethods

      public AuthorizationServerContractProperties withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)
      Set the authorizationMethods property: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
      Overrides:
      withAuthorizationMethods in class AuthorizationServerContractBaseProperties
      Parameters:
      authorizationMethods - the authorizationMethods value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • withClientAuthenticationMethod

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

    • withTokenBodyParameters

      public AuthorizationServerContractProperties 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:
      withTokenBodyParameters in class AuthorizationServerContractBaseProperties
      Parameters:
      tokenBodyParameters - the tokenBodyParameters value to set.
      Returns:
      the AuthorizationServerContractBaseProperties object itself.

    • withTokenEndpoint

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

    • withSupportState

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

    • withDefaultScope

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

    • withBearerTokenSendingMethods

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

    • withResourceOwnerUsername

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

    • withResourceOwnerPassword

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

    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class AuthorizationServerContractBaseProperties
      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>
      Overrides:
      toJson in class AuthorizationServerContractBaseProperties
      Throws:
      IOException

    • fromJson

      public static AuthorizationServerContractProperties fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AuthorizationServerContractProperties from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AuthorizationServerContractProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IllegalStateException - If the deserialized JSON object was missing any required properties.
      IOException - If an error occurs while reading the AuthorizationServerContractProperties.