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

Class IdentityProviderContractProperties

java.lang.Object
com.azure.resourcemanager.apimanagement.models.IdentityProviderBaseParameters
com.azure.resourcemanager.apimanagement.fluent.models.IdentityProviderContractProperties
All Implemented Interfaces:
com.azure.json.JsonSerializable<IdentityProviderBaseParameters>
public final class IdentityProviderContractProperties extends IdentityProviderBaseParameters
The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.

  • Constructor Details

    • IdentityProviderContractProperties

      public IdentityProviderContractProperties()
      Creates an instance of IdentityProviderContractProperties class.

  • Method Details

    • clientId

      public String clientId()
      Get the clientId property: Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
      Returns:
      the clientId value.

    • withClientId

      public IdentityProviderContractProperties withClientId(String clientId)
      Set the clientId property: Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
      Parameters:
      clientId - the clientId value to set.
      Returns:
      the IdentityProviderContractProperties object itself.

    • clientSecret

      public String clientSecret()
      Get the clientSecret property: Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
      Returns:
      the clientSecret value.

    • withClientSecret

      public IdentityProviderContractProperties withClientSecret(String clientSecret)
      Set the clientSecret property: Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. 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 IdentityProviderContractProperties object itself.

    • withType

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

    • withSigninTenant

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

    • withAllowedTenants

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

    • withAuthority

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

    • withSignupPolicyName

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

    • withSigninPolicyName

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

    • withProfileEditingPolicyName

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

    • withPasswordResetPolicyName

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

    • withClientLibrary

      public IdentityProviderContractProperties 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.
      Overrides:
      withClientLibrary in class IdentityProviderBaseParameters
      Parameters:
      clientLibrary - the clientLibrary value to set.
      Returns:
      the IdentityProviderBaseParameters object itself.

    • validate

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

    • fromJson

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