Class IdentityProviderContractProperties
- java.lang.Object
-
- com.azure.resourcemanager.apimanagement.models.IdentityProviderBaseParameters
-
- com.azure.resourcemanager.apimanagement.fluent.models.IdentityProviderContractProperties
-
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 Summary
Constructors Constructor Description IdentityProviderContractProperties()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
clientId()
Get the clientId property: Client Id of the Application in the external Identity Provider.String
clientSecret()
Get the clientSecret property: Client secret of the Application in external Identity Provider, used to authenticate login request.void
validate()
Validates the instance.IdentityProviderContractProperties
withAllowedTenants(List<String> allowedTenants)
Set the allowedTenants property: List of Allowed Tenants when configuring Azure Active Directory login.IdentityProviderContractProperties
withAuthority(String authority)
Set the authority property: OpenID Connect discovery endpoint hostname for AAD or AAD B2C.IdentityProviderContractProperties
withClientId(String clientId)
Set the clientId property: Client Id of the Application in the external Identity Provider.IdentityProviderContractProperties
withClientSecret(String clientSecret)
Set the clientSecret property: Client secret of the Application in external Identity Provider, used to authenticate login request.IdentityProviderContractProperties
withPasswordResetPolicyName(String passwordResetPolicyName)
Set the passwordResetPolicyName property: Password Reset Policy Name.IdentityProviderContractProperties
withProfileEditingPolicyName(String profileEditingPolicyName)
Set the profileEditingPolicyName property: Profile Editing Policy Name.IdentityProviderContractProperties
withSigninPolicyName(String signinPolicyName)
Set the signinPolicyName property: Signin Policy Name.IdentityProviderContractProperties
withSigninTenant(String signinTenant)
Set the signinTenant property: The TenantId to use instead of Common when logging into Active Directory.IdentityProviderContractProperties
withSignupPolicyName(String signupPolicyName)
Set the signupPolicyName property: Signup Policy Name.IdentityProviderContractProperties
withType(IdentityProviderType type)
Set the type property: Identity Provider Type identifier.-
Methods inherited from class com.azure.resourcemanager.apimanagement.models.IdentityProviderBaseParameters
allowedTenants, authority, passwordResetPolicyName, profileEditingPolicyName, signinPolicyName, signinTenant, signupPolicyName, type
-
-
-
-
Method Detail
-
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 classIdentityProviderBaseParameters
- 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 classIdentityProviderBaseParameters
- 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 classIdentityProviderBaseParameters
- 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 classIdentityProviderBaseParameters
- 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 classIdentityProviderBaseParameters
- 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 classIdentityProviderBaseParameters
- 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 classIdentityProviderBaseParameters
- 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 classIdentityProviderBaseParameters
- Parameters:
passwordResetPolicyName
- the passwordResetPolicyName value to set.- Returns:
- the IdentityProviderBaseParameters object itself.
-
validate
public void validate()
Validates the instance.- Overrides:
validate
in classIdentityProviderBaseParameters
- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-