Share via

IdentityProviderContract interface

  • Reference
Package:
@azure/arm-apimanagement

Identity Provider details.

Extends
ProxyResource

Properties

allowedTenants

List of Allowed Tenants when configuring Azure Active Directory login.
authority

OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
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.
clientLibrary

The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
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.
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.
typePropertiesType

Identity Provider Type identifier.

Inherited Properties

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.
name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.
type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

allowedTenants

List of Allowed Tenants when configuring Azure Active Directory login.

allowedTenants?: string[]

Property Value

string[]

authority

OpenID Connect discovery endpoint hostname for AAD or AAD B2C.

authority?: string

Property Value

string

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

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

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

passwordResetPolicyName

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

passwordResetPolicyName?: string

Property Value

string

profileEditingPolicyName

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

profileEditingPolicyName?: string

Property Value

string

signinPolicyName

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

signinPolicyName?: string

Property Value

string

signinTenant

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

signinTenant?: string

Property Value

string

signupPolicyName

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

signupPolicyName?: string

Property Value

string

typePropertiesType

Identity Provider Type identifier.

typePropertiesType?: string

Property Value

string

Inherited Property Details

id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyResource.id

name

The name of the resource NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyResource.name

type

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyResource.type