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

Class IdentityProviderUpdateProperties

java.lang.Object

com.azure.resourcemanager.apimanagement.models.IdentityProviderBaseParameters

com.azure.resourcemanager.apimanagement.fluent.models.IdentityProviderUpdateProperties

public final class IdentityProviderUpdateProperties
extends IdentityProviderBaseParameters

Parameters supplied to the Update Identity Provider operation.

Constructor Summary

Constructors

Constructor	Description
IdentityProviderUpdateProperties()

Method Summary

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.
IdentityProviderUpdateProperties	withAllowedTenants(List<String> allowedTenants)	Set the allowedTenants property: List of Allowed Tenants when configuring Azure Active Directory login.
IdentityProviderUpdateProperties	withAuthority(String authority)	Set the authority property: OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
IdentityProviderUpdateProperties	withClientId(String clientId)	Set the clientId property: Client Id of the Application in the external Identity Provider.
IdentityProviderUpdateProperties	withClientSecret(String clientSecret)	Set the clientSecret property: Client secret of the Application in external Identity Provider, used to authenticate login request.
IdentityProviderUpdateProperties	withPasswordResetPolicyName(String passwordResetPolicyName)	Set the passwordResetPolicyName property: Password Reset Policy Name.
IdentityProviderUpdateProperties	withProfileEditingPolicyName(String profileEditingPolicyName)	Set the profileEditingPolicyName property: Profile Editing Policy Name.
IdentityProviderUpdateProperties	withSigninPolicyName(String signinPolicyName)	Set the signinPolicyName property: Signin Policy Name.
IdentityProviderUpdateProperties	withSigninTenant(String signinTenant)	Set the signinTenant property: The TenantId to use instead of Common when logging into Active Directory.
IdentityProviderUpdateProperties	withSignupPolicyName(String signupPolicyName)	Set the signupPolicyName property: Signup Policy Name.
IdentityProviderUpdateProperties	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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdentityProviderUpdateProperties

public IdentityProviderUpdateProperties()

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

Returns:

the clientSecret value.

withClientSecret

public IdentityProviderUpdateProperties 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.

Parameters:

clientSecret - the clientSecret value to set.

Returns:

the IdentityProviderUpdateProperties object itself.

withType

public IdentityProviderUpdateProperties 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 IdentityProviderUpdateProperties 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 IdentityProviderUpdateProperties 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 IdentityProviderUpdateProperties 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 IdentityProviderUpdateProperties 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 IdentityProviderUpdateProperties 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 IdentityProviderUpdateProperties 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 IdentityProviderUpdateProperties 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.

validate

public void validate()

Validates the instance.

Overrides:

validate in class IdentityProviderBaseParameters

Throws:

IllegalArgumentException - thrown if the instance is not valid.