Package com.azure.resourcemanager.apimanagement.models

Class IdentityProviderBaseParameters

java.lang.Object
com.azure.resourcemanager.apimanagement.models.IdentityProviderBaseParameters
All Implemented Interfaces:
com.azure.json.JsonSerializable<IdentityProviderBaseParameters>
Direct Known Subclasses:
IdentityProviderContractProperties, IdentityProviderCreateContractProperties, IdentityProviderUpdateProperties
public class IdentityProviderBaseParameters extends Object implements com.azure.json.JsonSerializable<IdentityProviderBaseParameters>
Identity Provider Base Parameter Properties.

  • Constructor Details

    • IdentityProviderBaseParameters

      public IdentityProviderBaseParameters()
      Creates an instance of IdentityProviderBaseParameters class.

  • Method Details

    • type

      public IdentityProviderType type()
      Get the type property: Identity Provider Type identifier.
      Returns:
      the type value.

    • withType

      public IdentityProviderBaseParameters withType(IdentityProviderType type)
      Set the type property: Identity Provider Type identifier.
      Parameters:
      type - the type value to set.
      Returns:
      the IdentityProviderBaseParameters object itself.

    • signinTenant

      public String signinTenant()
      Get the signinTenant property: The TenantId to use instead of Common when logging into Active Directory.
      Returns:
      the signinTenant value.

    • withSigninTenant

      public IdentityProviderBaseParameters withSigninTenant(String signinTenant)
      Set the signinTenant property: The TenantId to use instead of Common when logging into Active Directory.
      Parameters:
      signinTenant - the signinTenant value to set.
      Returns:
      the IdentityProviderBaseParameters object itself.

    • allowedTenants

      public List<String> allowedTenants()
      Get the allowedTenants property: List of Allowed Tenants when configuring Azure Active Directory login.
      Returns:
      the allowedTenants value.

    • withAllowedTenants

      public IdentityProviderBaseParameters withAllowedTenants(List<String> allowedTenants)
      Set the allowedTenants property: List of Allowed Tenants when configuring Azure Active Directory login.
      Parameters:
      allowedTenants - the allowedTenants value to set.
      Returns:
      the IdentityProviderBaseParameters object itself.

    • authority

      public String authority()
      Get the authority property: OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
      Returns:
      the authority value.

    • withAuthority

      public IdentityProviderBaseParameters withAuthority(String authority)
      Set the authority property: OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
      Parameters:
      authority - the authority value to set.
      Returns:
      the IdentityProviderBaseParameters object itself.

    • signupPolicyName

      public String signupPolicyName()
      Get the signupPolicyName property: Signup Policy Name. Only applies to AAD B2C Identity Provider.
      Returns:
      the signupPolicyName value.

    • withSignupPolicyName

      public IdentityProviderBaseParameters withSignupPolicyName(String signupPolicyName)
      Set the signupPolicyName property: Signup Policy Name. Only applies to AAD B2C Identity Provider.
      Parameters:
      signupPolicyName - the signupPolicyName value to set.
      Returns:
      the IdentityProviderBaseParameters object itself.

    • signinPolicyName

      public String signinPolicyName()
      Get the signinPolicyName property: Signin Policy Name. Only applies to AAD B2C Identity Provider.
      Returns:
      the signinPolicyName value.

    • withSigninPolicyName

      public IdentityProviderBaseParameters withSigninPolicyName(String signinPolicyName)
      Set the signinPolicyName property: Signin Policy Name. Only applies to AAD B2C Identity Provider.
      Parameters:
      signinPolicyName - the signinPolicyName value to set.
      Returns:
      the IdentityProviderBaseParameters object itself.

    • profileEditingPolicyName

      public String profileEditingPolicyName()
      Get the profileEditingPolicyName property: Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
      Returns:
      the profileEditingPolicyName value.

    • withProfileEditingPolicyName

      public IdentityProviderBaseParameters withProfileEditingPolicyName(String profileEditingPolicyName)
      Set the profileEditingPolicyName property: Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
      Parameters:
      profileEditingPolicyName - the profileEditingPolicyName value to set.
      Returns:
      the IdentityProviderBaseParameters object itself.

    • passwordResetPolicyName

      public String passwordResetPolicyName()
      Get the passwordResetPolicyName property: Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
      Returns:
      the passwordResetPolicyName value.

    • withPasswordResetPolicyName

      public IdentityProviderBaseParameters withPasswordResetPolicyName(String passwordResetPolicyName)
      Set the passwordResetPolicyName property: Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
      Parameters:
      passwordResetPolicyName - the passwordResetPolicyName value to set.
      Returns:
      the IdentityProviderBaseParameters object itself.

    • clientLibrary

      public String clientLibrary()
      Get the clientLibrary property: The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
      Returns:
      the clientLibrary value.

    • withClientLibrary

      public IdentityProviderBaseParameters withClientLibrary(String clientLibrary)
      Set the clientLibrary property: The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
      Parameters:
      clientLibrary - the clientLibrary value to set.
      Returns:
      the IdentityProviderBaseParameters 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<IdentityProviderBaseParameters>
      Throws:
      IOException

    • fromJson

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