Package com.azure.resourcemanager.apimanagement.models

Interface IdentityProviderContract

public interface IdentityProviderContract
An immutable client-side representation of IdentityProviderContract.

  • Method Details

    • id

      String id()
      Gets the id property: Fully qualified resource Id for the resource.
      Returns:
      the id value.

    • name

      String name()
      Gets the name property: The name of the resource.
      Returns:
      the name value.

    • type

      String type()
      Gets the type property: The type of the resource.
      Returns:
      the type value.

    • clientId

      String clientId()
      Gets 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.

    • clientSecret

      String clientSecret()
      Gets 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.

    • typePropertiesType

      IdentityProviderType typePropertiesType()
      Gets the typePropertiesType property: Identity Provider Type identifier.
      Returns:
      the typePropertiesType value.

    • signinTenant

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

    • allowedTenants

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

    • authority

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

    • signupPolicyName

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

    • signinPolicyName

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

    • profileEditingPolicyName

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

    • passwordResetPolicyName

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

    • clientLibrary

      String clientLibrary()
      Gets 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.

    • resourceGroupName

      String resourceGroupName()
      Gets the name of the resource group.
      Returns:
      the name of the resource group.

    • innerModel

      IdentityProviderContractInner innerModel()
      Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.IdentityProviderContractInner object.
      Returns:
      the inner object.

    • update

      IdentityProviderContract.Update update()
      Begins update for the IdentityProviderContract resource.
      Returns:
      the stage of resource update.

    • refresh

      IdentityProviderContract refresh()
      Refreshes the resource to sync with Azure.
      Returns:
      the refreshed resource.

    • refresh

      IdentityProviderContract refresh(com.azure.core.util.Context context)
      Refreshes the resource to sync with Azure.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the refreshed resource.

    • listSecretsWithResponse

      com.azure.core.http.rest.Response<ClientSecretContract> listSecretsWithResponse(com.azure.core.util.Context context)
      Gets the client secret details of the Identity Provider.
      Parameters:
      context - The context to associate with this operation.
      Returns:
      the client secret details of the Identity Provider.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listSecrets

      ClientSecretContract listSecrets()
      Gets the client secret details of the Identity Provider.
      Returns:
      the client secret details of the Identity Provider.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.