Package com.azure.resourcemanager.apimanagement.models

Class IdentityProviderCreateContract

java.lang.Object
com.azure.core.management.ProxyResource
com.azure.resourcemanager.apimanagement.models.IdentityProviderCreateContract
All Implemented Interfaces:
com.azure.json.JsonSerializable<com.azure.core.management.ProxyResource>
public final class IdentityProviderCreateContract extends com.azure.core.management.ProxyResource
Identity Provider details.

  • Constructor Details

    • IdentityProviderCreateContract

      public IdentityProviderCreateContract()
      Creates an instance of IdentityProviderCreateContract class.

  • Method Details

    • type

      public String type()
      Get the type property: The type of the resource.
      Overrides:
      type in class com.azure.core.management.ProxyResource
      Returns:
      the type value.

    • name

      public String name()
      Get the name property: The name of the resource.
      Overrides:
      name in class com.azure.core.management.ProxyResource
      Returns:
      the name value.

    • id

      public String id()
      Get the id property: Fully qualified resource Id for the resource.
      Overrides:
      id in class com.azure.core.management.ProxyResource
      Returns:
      the id value.

    • 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract object itself.

    • typePropertiesType

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

    • withTypePropertiesType

      public IdentityProviderCreateContract withTypePropertiesType(IdentityProviderType type)
      Set the type property: Identity Provider Type identifier.
      Parameters:
      type - the type value to set.
      Returns:
      the IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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 IdentityProviderCreateContract 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<com.azure.core.management.ProxyResource>
      Overrides:
      toJson in class com.azure.core.management.ProxyResource
      Throws:
      IOException

    • fromJson

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