IdentityProviderContractProperties interface

Package:

@azure/arm-apimanagement

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.

Extends

IdentityProviderBaseParameters

Properties

clientId	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.
clientSecret	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.

Inherited Properties

allowedTenants	List of Allowed Tenants when configuring Azure Active Directory login.
authority	OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
clientLibrary	The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
passwordResetPolicyName	Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profileEditingPolicyName	Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signinPolicyName	Signin Policy Name. Only applies to AAD B2C Identity Provider.
signinTenant	The TenantId to use instead of Common when logging into Active Directory
signupPolicyName	Signup Policy Name. Only applies to AAD B2C Identity Provider.
type	Identity Provider Type identifier.

Property Details

clientId

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.

clientId: string

Property Value

string

clientSecret

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.

clientSecret?: string

Property Value

string

Inherited Property Details

allowedTenants

List of Allowed Tenants when configuring Azure Active Directory login.

allowedTenants?: string[]

Property Value

string[]

Inherited From IdentityProviderBaseParameters.allowedTenants

authority

OpenID Connect discovery endpoint hostname for AAD or AAD B2C.

authority?: string

Property Value

string

Inherited From IdentityProviderBaseParameters.authority

clientLibrary

The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.

clientLibrary?: string

Property Value

string

Inherited From IdentityProviderBaseParameters.clientLibrary

passwordResetPolicyName

Password Reset Policy Name. Only applies to AAD B2C Identity Provider.

passwordResetPolicyName?: string

Property Value

string

Inherited From IdentityProviderBaseParameters.passwordResetPolicyName

profileEditingPolicyName

Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.

profileEditingPolicyName?: string

Property Value

string

Inherited From IdentityProviderBaseParameters.profileEditingPolicyName

signinPolicyName

Signin Policy Name. Only applies to AAD B2C Identity Provider.

signinPolicyName?: string

Property Value

string

Inherited From IdentityProviderBaseParameters.signinPolicyName

signinTenant

The TenantId to use instead of Common when logging into Active Directory

signinTenant?: string

Property Value

string

Inherited From IdentityProviderBaseParameters.signinTenant

signupPolicyName

Signup Policy Name. Only applies to AAD B2C Identity Provider.

signupPolicyName?: string

Property Value

string

Inherited From IdentityProviderBaseParameters.signupPolicyName

type

Identity Provider Type identifier.

type?: string

Property Value

string

Inherited From IdentityProviderBaseParameters.type