identity_provider

Creates, updates, deletes, gets or lists an identity_provider resource.

Overview

Name	identity_provider
Type	Resource
Id	azure.api_management.identity_provider

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowedTenants	array	List of Allowed Tenants when configuring Azure Active Directory login.
authority	string	OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
certificateId	string	Certificate full resource ID used in external Identity Provider.
clientId	string	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. Required.
clientLibrary	string	The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
clientSecret	string	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	string	Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profileEditingPolicyName	string	Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signinPolicyName	string	Signin Policy Name. Only applies to AAD B2C Identity Provider.
signinTenant	string	The TenantId to use instead of Common when logging into Active Directory.
signupPolicyName	string	Signup Policy Name. Only applies to AAD B2C Identity Provider.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_service

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowedTenants	array	List of Allowed Tenants when configuring Azure Active Directory login.
authority	string	OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
certificateId	string	Certificate full resource ID used in external Identity Provider.
clientId	string	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. Required.
clientLibrary	string	The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
clientSecret	string	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	string	Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
profileEditingPolicyName	string	Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
signinPolicyName	string	Signin Policy Name. Only applies to AAD B2C Identity Provider.
signinTenant	string	The TenantId to use instead of Common when logging into Active Directory.
signupPolicyName	string	Signup Policy Name. Only applies to AAD B2C Identity Provider.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, service_name, identity_provider_name, subscription_id		Gets the configuration details of the identity Provider configured in specified service instance.
list_by_service	select	resource_group_name, service_name, subscription_id		Lists a collection of Identity Provider configured in the specified service instance.
create_or_update	insert	resource_group_name, service_name, identity_provider_name, subscription_id		Creates or Updates the IdentityProvider configuration.
update	update	resource_group_name, service_name, identity_provider_name, subscription_id		Updates an existing IdentityProvider configuration.
create_or_update	replace	resource_group_name, service_name, identity_provider_name, subscription_id		Creates or Updates the IdentityProvider configuration.
delete	delete	resource_group_name, service_name, identity_provider_name, subscription_id		Deletes the specified identity provider configuration.
get_entity_tag	exec	resource_group_name, service_name, identity_provider_name, subscription_id		Gets the entity state (Etag) version of the identityProvider specified by its identifier.
list_secrets	exec	resource_group_name, service_name, identity_provider_name, subscription_id		Gets the client secret details of the Identity Provider.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
identity_provider_name	string	Identity Provider Type identifier. Known values are: "facebook", "google", "microsoft", "twitter", "aad", and "aadB2C". Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
service_name	string	The name of the API Management service. Required.
subscription_id	string

SELECT examples

get

Gets the configuration details of the identity Provider configured in specified service instance.

SELECT
id,
name,
allowedTenants,
authority,
certificateId,
clientId,
clientLibrary,
clientSecret,
passwordResetPolicyName,
profileEditingPolicyName,
signinPolicyName,
signinTenant,
signupPolicyName,
systemData,
type
FROM azure.api_management.identity_provider
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND identity_provider_name = '{{ identity_provider_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_service

Lists a collection of Identity Provider configured in the specified service instance.

SELECT
id,
name,
allowedTenants,
authority,
certificateId,
clientId,
clientLibrary,
clientSecret,
passwordResetPolicyName,
profileEditingPolicyName,
signinPolicyName,
signinTenant,
signupPolicyName,
systemData,
type
FROM azure.api_management.identity_provider
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND service_name = '{{ service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or Updates the IdentityProvider configuration.

INSERT INTO azure.api_management.identity_provider (
properties,
resource_group_name,
service_name,
identity_provider_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ service_name }}',
'{{ identity_provider_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: identity_provider
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the identity_provider resource.
  - name: service_name
    value: "{{ service_name }}"
    description: Required parameter for the identity_provider resource.
  - name: identity_provider_name
    value: "{{ identity_provider_name }}"
    description: Required parameter for the identity_provider resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the identity_provider resource.
  - name: properties
    description: |
      Identity Provider contract properties.
    value:
      type: "{{ type }}"
      signinTenant: "{{ signinTenant }}"
      allowedTenants:
        - "{{ allowedTenants }}"
      authority: "{{ authority }}"
      signupPolicyName: "{{ signupPolicyName }}"
      signinPolicyName: "{{ signinPolicyName }}"
      profileEditingPolicyName: "{{ profileEditingPolicyName }}"
      passwordResetPolicyName: "{{ passwordResetPolicyName }}"
      clientLibrary: "{{ clientLibrary }}"
      clientId: "{{ clientId }}"
      clientSecret: "{{ clientSecret }}"
      certificateId: "{{ certificateId }}"

UPDATE examples

update

Updates an existing IdentityProvider configuration.

UPDATE azure.api_management.identity_provider
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND identity_provider_name = '{{ identity_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Creates or Updates the IdentityProvider configuration.

REPLACE azure.api_management.identity_provider
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND identity_provider_name = '{{ identity_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified identity provider configuration.

DELETE FROM azure.api_management.identity_provider
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND service_name = '{{ service_name }}' --required
AND identity_provider_name = '{{ identity_provider_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_entity_tag

Gets the entity state (Etag) version of the identityProvider specified by its identifier.

EXEC azure.api_management.identity_provider.get_entity_tag 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@identity_provider_name='{{ identity_provider_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_secrets

Gets the client secret details of the Identity Provider.

EXEC azure.api_management.identity_provider.list_secrets 
@resource_group_name='{{ resource_group_name }}' --required, 
@service_name='{{ service_name }}' --required, 
@identity_provider_name='{{ identity_provider_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;