Support · Installation · License · Related Integrations
The Azure App Registration and Enterprise Application Orchestrator extension remotely manages both Azure App Registration/Application certificates and Enterprise Application/Service Principal certificates. Application certificates are typically public key only and used for client certificate authentication, while Service Principal certificates are commonly used for SAML Assertion signing. The extension implements the Inventory, Management Add, Management Remove and Discovery job types.
Certificates used for client authentication by Applications (configured in App Registrations) are represented by the
AzureApp store type, and certificates used for SSO/SAML assertion signing are represented by the
AzureSP store type. Both store types are managed by the same extension. The extension is configured
with a single Azure Service Principal used to authenticate to
the Microsoft Graph API. The Azure App Registration and
Enterprise Application Orchestrator extension manages certificates for Azure App Registrations (Applications) and
Enterprise Applications (Service Principals) differently.
The Azure App Registration and Enterprise Application Universal Orchestrator extension implements 4 Certificate Store Types. Depending on your use case, you may elect to use one, or all of these Certificate Store Types. Descriptions of each are provided below.
This integration is compatible with Keyfactor Universal Orchestrator version 10.4 and later.
The Azure App Registration and Enterprise Application Universal Orchestrator extension If you have a support issue, please open a support ticket by either contacting your Keyfactor representative or via the Keyfactor Support Portal at https://support.keyfactor.com.
To report a problem or suggest a new feature, use the Issues tab. If you want to contribute actual bug fixes or proposed enhancements, use the Pull requests tab.
Before installing the Azure App Registration and Enterprise Application Universal Orchestrator extension, we recommend that you install kfutil. Kfutil is a command-line tool that simplifies the process of creating store types, installing extensions, and instantiating certificate stores in Keyfactor Command.
The Azure App Registration and Enterprise Application Orchestrator extension uses an Azure Service Principal for authentication. Follow Microsoft's documentation to create a service principal. Currently, both Client Secret authentication and Client Certificate authentication (mTLS) are supported.
The Service Principal must have the following API Permission:
- Microsoft Graph Application Permissions:
Application.ReadWrite.All(not Delegated; Admin Consent)—Allows the app to create, read, update and delete applications and service principals without a signed-in user.
Note
For more information on Admin Consent for App-only access (also called "Application Permissions"), see the primer on application-only access.
Alternatively, the Service Principal can be granted the Application.ReadWrite.OwnedBy permission if the Service
Principal is only intended to manage its own App Registration/Application.
Beginning in version 3.0.0, the Azure App Registration and Enterprise Application Orchestrator extension supports both client certificate authentication and client secret authentication.
-
Client Secret— Follow Microsoft's documentation to create a Client Secret. This secret will be used as the Server Password field in the Certificate Store Configuration section.
-
Client Certificate— Create a client certificate key pair with the Client Authentication extended key usage. The client certificate will be used in the ClientCertificate field in the Certificate Store Configuration section. If you have access to Keyfactor Command, the instructions in this section walk you through enrolling a certificate and ensuring that it's in the correct format. Once enrolled, follow Microsoft's documentation to add the public key certificate (no private key) to the service principal used for authentication.
The certificate can be in either of the following formats:
- Base64-encoded PKCS#12 (PFX) with a matching private key.
- Base64-encoded PEM-encoded certificate and PEM-encoded PKCS8 private key. Make sure that the certificate and private key are separated with a newline. The order doesn't matter; the extension will determine which is which.
If the private key is encrypted, the encryption password will replace the Server Password field in the Certificate Store Configuration section.
To get started quickly, you can follow the instructions below to create and properly format a client certificate to authenticate to the Microsoft Graph API.
-
In Keyfactor Command, hover over Enrollment and select PFX Enrollment.
-
Select a Template that supports Client Authentication as an extended key usage.
-
Populate the certificate subject as appropriate for the Template. It may be enough to only populate the Common Name, but consult your IT policy to ensure that this certificate is compliant.
-
At the bottom of the page, uncheck the box for Include Chain, and select either PFX or PEM as the certificate Format.
-
Make a note of the password on the next page it won't be shown again.
-
Prepare the certificate and private key for Azure and the Orchestrator extension:
-
If you downloaded the certificate in PEM format, use the commands below:
# Verify that the certificate downloaded from Command contains the certificate and private key. They should be in the same file cat <your_certificate.pem # Separate the certificate from the private key openssl x509 -in <your_certificate.pem-out pubkeycert.pem # Base64 encode the certificate and private key cat <your_certificate.pem| base64 clientcertkeypair.pem.base64
- If you downloaded the certificate in PFX format, use the commands below:
# Export the certificate from the PFX file openssl pkcs12 -in <your_certificate.pfx-clcerts -nokeys -out pubkeycert.pem # Base64 encode the PFX file cat <your_certificate.pfx| base64 clientcert.pfx.base64
-
-
Follow Microsoft's documentation to add the public key certificate to the service principal used for authentication.
You will use clientcert.[pem|pfx].base64 as the ClientCertificate field in
the Certificate Store Configuration section.
The Azure App Registration and Enterprise Application Orchestrator extension uses the Microsoft Dotnet Graph SDK to interact with the Microsoft Graph API. The extension uses the following Graph API endpoints to manage Application certificates:
- Get Application - Used to get the Object ID of the App Registration and to download the certificates owned by the App Registration.
- Update Application - Used to modify the App Registration to add or remove certificates.
- Specifically, the extension manipulates the
keyCredentialsresource of the Application object.
- Specifically, the extension manipulates the
To use the Azure App Registration and Enterprise Application Universal Orchestrator extension, you must create the Certificate Store Types required for your usecase. This only needs to happen once per Keyfactor Command instance.
The Azure App Registration and Enterprise Application Universal Orchestrator extension implements 4 Certificate Store Types. Depending on your use case, you may elect to use one, or all of these Certificate Store Types.
Click to expand details
Azure App Registration/Application certificates are typically used for client authentication by applications and are typically public key only in Azure. The general model by which these credentials are consumed is that the certificate and private key are accessible by the Application using the App Registration, and are passed to the service authenticating the Application. The Azure App Registration and Enterprise Application Orchestrator extension implements the Inventory, Management Add, Management Remove, and Discovery job types for managing these certificates.
[!WARNING] AzureApp "Azure App Registration (Application)" is Deprecated. Please use AzureApp2 "Azure App Registration 2 (Application)" instead.
Application certificates are used for client authentication and are typically public key only. No additional configuration in Azure is necessary to manage Application certificates since all App Registrations can contain any number of Certificates and Secrets. Unless the Discovery job is used, you should collect the Application IDs for each App Registration that contains certificates to be managed.
| Operation | Is Supported |
|---|---|
| Add | âś… Checked |
| Remove | âś… Checked |
| Discovery | âś… Checked |
| Reenrollment | 🔲 Unchecked |
| Create | 🔲 Unchecked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
For more information on kfutil check out the docs
Click to expand AzureApp kfutil details
This will reach out to GitHub and pull the latest store-type definition
# Azure App Registration (Application)
kfutil store-types create AzureAppIf required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the AzureApp store type manually in the Keyfactor Command Portal
Click to expand manual AzureApp details
Create a store type called AzureApp with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | Azure App Registration (Application) | Display name for the store type (may be customized) |
| Short Name | AzureApp | Short display name for the store type |
| Capability | AzureApp | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | âś… Checked | Check the box. Indicates that the Store Type supports Management Add |
| Supports Remove | âś… Checked | Check the box. Indicates that the Store Type supports Management Remove |
| Supports Discovery | âś… Checked | Check the box. Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Forbidden | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
For Keyfactor Command versions 24.4 and later, a Certificate Format dropdown is available with PFX and PEM options. Ensure that PFX is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| ServerUsername | Server Username | The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. | Secret | âś… Checked | |
| ServerPassword | Server Password | A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used and the Client Certificate's private key is not encrypted, you must select 'No Value' for this field. | Secret | 🔲 Unchecked | |
| ClientCertificate | Client Certificate | The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the requirements for more information. If Client Certificate Auth is not used, you must select 'No Value' for this field. | Secret | 🔲 Unchecked | |
| AzureCloud | Azure Global Cloud Authority Host | Specifies the Azure Cloud instance used by the organization. | MultipleChoice | public,china,germany,government | 🔲 Unchecked |
| ServerUseSsl | Use SSL | Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it. | Bool | true | âś… Checked |
The Custom Fields tab should look like this:
Click to expand details
The Azure Enterprise Application/Service Principal certificate operations are implemented by the AzureSP store type,
and supports the management of a single certificate for use in SSO/SAML assertion signing. The Management Add
operation is only supported with the certificate replacement option, since adding a new certificate will replace the
existing
certificate. The Add operation will also set newly added certificates as the active certificate for SSO/SAML usage. The
Management Remove operation removes the certificate from the Enterprise Application/Service Principal, which is the same
as removing the SSO/SAML signing certificate. The Discovery operation discovers all Enterprise Applications/Service
Principals in the tenant.
[!WARNING] AzureSP "Azure Enterprise Application (Service Principal)" is Deprecated. Please use AzureSP2 Azure "Enterprise Application 2 (Service Principal)" instead.
Service Principal certificates are typically used for SAML Token signing. Service Principals are created from Enterprise Applications and will mostly be configured with a variation of Microsoft's SAML-based single sign-on documentation. For more information on the mechanics of the Service Principal certificate management capabilities, please see the mechanics section.
| Operation | Is Supported |
|---|---|
| Add | âś… Checked |
| Remove | âś… Checked |
| Discovery | âś… Checked |
| Reenrollment | 🔲 Unchecked |
| Create | 🔲 Unchecked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
For more information on kfutil check out the docs
Click to expand AzureSP kfutil details
This will reach out to GitHub and pull the latest store-type definition
# Azure Enterprise Application (Service Principal)
kfutil store-types create AzureSPIf required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the AzureSP store type manually in the Keyfactor Command Portal
Click to expand manual AzureSP details
Create a store type called AzureSP with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | Azure Enterprise Application (Service Principal) | Display name for the store type (may be customized) |
| Short Name | AzureSP | Short display name for the store type |
| Capability | AzureSP | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | âś… Checked | Check the box. Indicates that the Store Type supports Management Add |
| Supports Remove | âś… Checked | Check the box. Indicates that the Store Type supports Management Remove |
| Supports Discovery | âś… Checked | Check the box. Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Required | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
For Keyfactor Command versions 24.4 and later, a Certificate Format dropdown is available with PFX and PEM options. Ensure that PFX is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| ServerUsername | Server Username | The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. | Secret | âś… Checked | |
| ServerPassword | Server Password | A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used and the Client Certificate's private key is not encrypted, you must select 'No Value' for this field. | Secret | 🔲 Unchecked | |
| ClientCertificate | Client Certificate | The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the requirements for more information. If Client Certificate Auth is not used, you must select 'No Value' for this field. | Secret | 🔲 Unchecked | |
| AzureCloud | Azure Global Cloud Authority Host | Specifies the Azure Cloud instance used by the organization. | MultipleChoice | public,china,germany,government | 🔲 Unchecked |
| ServerUseSsl | Use SSL | Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it. | Bool | true | âś… Checked |
The Custom Fields tab should look like this:
Click to expand details
Azure App Registration/Application certificates are typically used for client authentication by applications and are typically public key only in Azure. The general model by which these credentials are consumed is that the certificate and private key are accessible by the Application using the App Registration, and are passed to the service authenticating the Application. The Azure App Registration and Enterprise Application Orchestrator extension implements the Inventory, Management Add, Management Remove, and Discovery job types for managing these certificates.
Application certificates are used for client authentication and are typically public key only. No additional configuration in Azure is necessary to manage Application certificates since all App Registrations can contain any number of Certificates and Secrets. Unless the Discovery job is used, you should collect the Application IDs for each App Registration that contains certificates to be managed.
| Operation | Is Supported |
|---|---|
| Add | âś… Checked |
| Remove | âś… Checked |
| Discovery | âś… Checked |
| Reenrollment | 🔲 Unchecked |
| Create | 🔲 Unchecked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
For more information on kfutil check out the docs
Click to expand AzureApp2 kfutil details
This will reach out to GitHub and pull the latest store-type definition
# Azure App Registration 2 (Application)
kfutil store-types create AzureApp2If required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the AzureApp2 store type manually in the Keyfactor Command Portal
Click to expand manual AzureApp2 details
Create a store type called AzureApp2 with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | Azure App Registration 2 (Application) | Display name for the store type (may be customized) |
| Short Name | AzureApp2 | Short display name for the store type |
| Capability | AzureApp2 | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | âś… Checked | Check the box. Indicates that the Store Type supports Management Add |
| Supports Remove | âś… Checked | Check the box. Indicates that the Store Type supports Management Remove |
| Supports Discovery | âś… Checked | Check the box. Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Forbidden | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
For Keyfactor Command versions 24.4 and later, a Certificate Format dropdown is available with PFX and PEM options. Ensure that PFX is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| ServerUsername | Server Username | The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/App Registration certificates. | Secret | âś… Checked | |
| ServerPassword | Server Password | A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/App Registration certificates. If Client Certificate Auth is used, you must select 'No Value'. | Secret | 🔲 Unchecked | |
| ClientCertificate | Client Certificate | The client certificate used to authenticate with Microsoft Graph for managing Application/App Registrations certificates. See the requirements for more information. If Client Certificate Auth is not used, you must check 'No Value'. | Secret | 🔲 Unchecked | |
| ClientCertificatePassword | Client Certificate Password | The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used, you must check 'No Value'. | Secret | 🔲 Unchecked | |
| AzureCloud | Azure Global Cloud Authority Host | Specifies the Azure Cloud instance used by the organization. | MultipleChoice | public,china,germany,government | 🔲 Unchecked |
The Custom Fields tab should look like this:
Click to expand details
The Azure Enterprise Application/Service Principal certificate operations are implemented by the AzureSP store type,
and supports the management of a single certificate for use in SSO/SAML assertion signing. The Management Add operation
is only supported with the certificate replacement option, since adding a new certificate will replace the existing
certificate. The Add operation will also set newly added certificates as the active certificate for SSO/SAML usage. The
Management Remove operation removes the certificate from the Enterprise Application/Service Principal, which is the same
as removing the SSO/SAML signing certificate. The Discovery operation discovers all Enterprise Applications/Service
Principals in the tenant.
Service Principal certificates are typically used for SAML Token signing. Service Principals are created from Enterprise Applications and will mostly be configured with a variation of Microsoft's SAML-based single sign-on documentation. For more information on the mechanics of the Service Principal certificate management capabilities, please see the mechanics section.
| Operation | Is Supported |
|---|---|
| Add | âś… Checked |
| Remove | âś… Checked |
| Discovery | âś… Checked |
| Reenrollment | 🔲 Unchecked |
| Create | 🔲 Unchecked |
kfutil is a custom CLI for the Keyfactor Command API and can be used to created certificate store types.
For more information on kfutil check out the docs
Click to expand AzureSP2 kfutil details
This will reach out to GitHub and pull the latest store-type definition
# Azure Enterprise Application 2 (Service Principal)
kfutil store-types create AzureSP2If required, it is possible to create store types from the integration-manifest.json included in this repo. You would first download the integration-manifest.json and then run the following command in your offline environment.
kfutil store-types create --from-file integration-manifest.jsonBelow are instructions on how to create the AzureSP2 store type manually in the Keyfactor Command Portal
Click to expand manual AzureSP2 details
Create a store type called AzureSP2 with the attributes in the tables below:
| Attribute | Value | Description |
|---|---|---|
| Name | Azure Enterprise Application 2 (Service Principal) | Display name for the store type (may be customized) |
| Short Name | AzureSP2 | Short display name for the store type |
| Capability | AzureSP2 | Store type name orchestrator will register with. Check the box to allow entry of value |
| Supports Add | âś… Checked | Check the box. Indicates that the Store Type supports Management Add |
| Supports Remove | âś… Checked | Check the box. Indicates that the Store Type supports Management Remove |
| Supports Discovery | âś… Checked | Check the box. Indicates that the Store Type supports Discovery |
| Supports Reenrollment | 🔲 Unchecked | Indicates that the Store Type supports Reenrollment |
| Supports Create | 🔲 Unchecked | Indicates that the Store Type supports store creation |
| Needs Server | âś… Checked | Determines if a target server name is required when creating store |
| Blueprint Allowed | 🔲 Unchecked | Determines if store type may be included in an Orchestrator blueprint |
| Uses PowerShell | 🔲 Unchecked | Determines if underlying implementation is PowerShell |
| Requires Store Password | 🔲 Unchecked | Enables users to optionally specify a store password when defining a Certificate Store. |
| Supports Entry Password | 🔲 Unchecked | Determines if an individual entry within a store can have a password. |
The Basic tab should look like this:
| Attribute | Value | Description |
|---|---|---|
| Supports Custom Alias | Required | Determines if an individual entry within a store can have a custom Alias. |
| Private Key Handling | Required | This determines if Keyfactor can send the private key associated with a certificate to the store. Required because IIS certificates without private keys would be invalid. |
| PFX Password Style | Default | 'Default' - PFX password is randomly generated, 'Custom' - PFX password may be specified when the enrollment job is created (Requires the Allow Custom Password application setting to be enabled.) |
The Advanced tab should look like this:
For Keyfactor Command versions 24.4 and later, a Certificate Format dropdown is available with PFX and PEM options. Ensure that PFX is selected, as this determines the format of new and renewed certificates sent to the Orchestrator during a Management job. Currently, all Keyfactor-supported Orchestrator extensions support only PFX.
Custom fields operate at the certificate store level and are used to control how the orchestrator connects to the remote target server containing the certificate store to be managed. The following custom fields should be added to the store type:
| Name | Display Name | Description | Type | Default Value/Options | Required |
|---|---|---|---|---|---|
| ServerUsername | Server Username | The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. | Secret | âś… Checked | |
| ServerPassword | Server Password | A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. If Client Certificate Auth is used, you must check 'No Value'. | Secret | 🔲 Unchecked | |
| ClientCertificate | Client Certificate | The client certificate used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. See the requirements for more information. If Client Certificate Auth is not used, you must check 'No Value'. | Secret | 🔲 Unchecked | |
| ClientCertificatePassword | Client Certificate Password | The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used or the certificate's private key is not encrypted, you must check 'No Value'. | Secret | 🔲 Unchecked | |
| AzureCloud | Azure Global Cloud Authority Host | Specifies the Azure Cloud instance used by the organization. | MultipleChoice | public,china,germany,government | 🔲 Unchecked |
The Custom Fields tab should look like this:
-
Download the latest Azure App Registration and Enterprise Application Universal Orchestrator extension from GitHub.
Navigate to the Azure App Registration and Enterprise Application Universal Orchestrator extension GitHub version page. Refer to the compatibility matrix below to determine whether the
net6.0ornet8.0asset should be downloaded. Then, click the corresponding asset to download the zip archive.Universal Orchestrator Version Latest .NET version installed on the Universal Orchestrator server rollForwardcondition inOrchestrator.runtimeconfig.jsonazure-application-orchestrator.NET version to downloadOlder than 11.0.0net6.0Between 11.0.0and11.5.1(inclusive)net6.0net6.0Between 11.0.0and11.5.1(inclusive)net8.0Disablenet6.0Between 11.0.0and11.5.1(inclusive)net8.0LatestMajornet8.011.6and newernet8.0net8.0Unzip the archive containing extension assemblies to a known location.
Note If you don't see an asset with a corresponding .NET version, you should always assume that it was compiled for
net6.0. -
Locate the Universal Orchestrator extensions directory.
- Default on Windows -
C:\Program Files\Keyfactor\Keyfactor Orchestrator\extensions - Default on Linux -
/opt/keyfactor/orchestrator/extensions
- Default on Windows -
-
Create a new directory for the Azure App Registration and Enterprise Application Universal Orchestrator extension inside the extensions directory.
Create a new directory called
azure-application-orchestrator.The directory name does not need to match any names used elsewhere; it just has to be unique within the extensions directory.
-
Copy the contents of the downloaded and unzipped assemblies from step 2 to the
azure-application-orchestratordirectory. -
Restart the Universal Orchestrator service.
Refer to Starting/Restarting the Universal Orchestrator service.
-
(optional) PAM Integration
The Azure App Registration and Enterprise Application Universal Orchestrator extension is compatible with all supported Keyfactor PAM extensions to resolve PAM-eligible secrets. PAM extensions running on Universal Orchestrators enable secure retrieval of secrets from a connected PAM provider.
To configure a PAM provider, reference the Keyfactor Integration Catalog to select an extension and follow the associated instructions to install it on the Universal Orchestrator (remote).
The above installation steps can be supplemented by the official Command documentation.
The Azure App Registration and Enterprise Application Universal Orchestrator extension implements 4 Certificate Store Types, each of which implements different functionality. Refer to the individual instructions below for each Certificate Store Type that you deemed necessary for your use case from the installation section.
Azure App Registration (Application) (AzureApp)
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "Azure App Registration (Application)" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine The Azure Tenant (directory) ID that owns the Service Principal. Store Path The Application ID of the target Application/Service Principal that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension. Orchestrator Select an approved orchestrator capable of managing AzureAppcertificates. Specifically, one with theAzureAppcapability.ServerUsername The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. ServerPassword A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used and the Client Certificate's private key is not encrypted, you must select 'No Value' for this field. ClientCertificate The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the requirements for more information. If Client Certificate Auth is not used, you must select 'No Value' for this field. AzureCloud Specifies the Azure Cloud instance used by the organization. ServerUseSsl Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it.
Click to expand details
-
Generate a CSV template for the AzureApp certificate store
kfutil stores import generate-template --store-type-name AzureApp --outpath AzureApp.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "Azure App Registration (Application)" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine The Azure Tenant (directory) ID that owns the Service Principal. Store Path The Application ID of the target Application/Service Principal that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension. Orchestrator Select an approved orchestrator capable of managing AzureAppcertificates. Specifically, one with theAzureAppcapability.Properties.ServerUsername The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. Properties.ServerPassword A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used and the Client Certificate's private key is not encrypted, you must select 'No Value' for this field. Properties.ClientCertificate The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the requirements for more information. If Client Certificate Auth is not used, you must select 'No Value' for this field. Properties.AzureCloud Specifies the Azure Cloud instance used by the organization. Properties.ServerUseSsl Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it. -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name AzureApp --file AzureApp.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. |
| ServerPassword | A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used and the Client Certificate's private key is not encrypted, you must select 'No Value' for this field. |
| ClientCertificate | The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the requirements for more information. If Client Certificate Auth is not used, you must select 'No Value' for this field. |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
Azure Enterprise Application (Service Principal) (AzureSP)
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "Azure Enterprise Application (Service Principal)" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine The Azure Tenant (directory) ID that owns the Service Principal. Store Path The Application ID of the target Application/Service Principal that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension. Orchestrator Select an approved orchestrator capable of managing AzureSPcertificates. Specifically, one with theAzureSPcapability.ServerUsername The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. ServerPassword A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used and the Client Certificate's private key is not encrypted, you must select 'No Value' for this field. ClientCertificate The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the requirements for more information. If Client Certificate Auth is not used, you must select 'No Value' for this field. AzureCloud Specifies the Azure Cloud instance used by the organization. ServerUseSsl Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it.
Click to expand details
-
Generate a CSV template for the AzureSP certificate store
kfutil stores import generate-template --store-type-name AzureSP --outpath AzureSP.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "Azure Enterprise Application (Service Principal)" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine The Azure Tenant (directory) ID that owns the Service Principal. Store Path The Application ID of the target Application/Service Principal that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension. Orchestrator Select an approved orchestrator capable of managing AzureSPcertificates. Specifically, one with theAzureSPcapability.Properties.ServerUsername The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. Properties.ServerPassword A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used and the Client Certificate's private key is not encrypted, you must select 'No Value' for this field. Properties.ClientCertificate The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the requirements for more information. If Client Certificate Auth is not used, you must select 'No Value' for this field. Properties.AzureCloud Specifies the Azure Cloud instance used by the organization. Properties.ServerUseSsl Specifies whether SSL should be used for communication with the server. Set to 'true' to enable SSL, and 'false' to disable it. -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name AzureSP --file AzureSP.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. |
| ServerPassword | A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/Service Principal certificates, OR the password that encrypts the private key in ClientCertificate. If Client Cert Auth is used and the Client Certificate's private key is not encrypted, you must select 'No Value' for this field. |
| ClientCertificate | The client certificate used to authenticate with Microsoft Graph for managing Application/Service Principal certificates. See the requirements for more information. If Client Certificate Auth is not used, you must select 'No Value' for this field. |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
Azure App Registration 2 (Application) (AzureApp2)
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "Azure App Registration 2 (Application)" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine The Azure Tenant (directory) ID where the Application is instantiated Store Path The Object ID of the target Application/App Registration that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension. Orchestrator Select an approved orchestrator capable of managing AzureApp2certificates. Specifically, one with theAzureApp2capability.ServerUsername The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/App Registration certificates. ServerPassword A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/App Registration certificates. If Client Certificate Auth is used, you must select 'No Value'. ClientCertificate The client certificate used to authenticate with Microsoft Graph for managing Application/App Registrations certificates. See the requirements for more information. If Client Certificate Auth is not used, you must check 'No Value'. ClientCertificatePassword The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used, you must check 'No Value'. AzureCloud Specifies the Azure Cloud instance used by the organization.
Click to expand details
-
Generate a CSV template for the AzureApp2 certificate store
kfutil stores import generate-template --store-type-name AzureApp2 --outpath AzureApp2.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "Azure App Registration 2 (Application)" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine The Azure Tenant (directory) ID where the Application is instantiated Store Path The Object ID of the target Application/App Registration that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension. Orchestrator Select an approved orchestrator capable of managing AzureApp2certificates. Specifically, one with theAzureApp2capability.Properties.ServerUsername The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/App Registration certificates. Properties.ServerPassword A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/App Registration certificates. If Client Certificate Auth is used, you must select 'No Value'. Properties.ClientCertificate The client certificate used to authenticate with Microsoft Graph for managing Application/App Registrations certificates. See the requirements for more information. If Client Certificate Auth is not used, you must check 'No Value'. Properties.ClientCertificatePassword The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used, you must check 'No Value'. Properties.AzureCloud Specifies the Azure Cloud instance used by the organization. -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name AzureApp2 --file AzureApp2.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Application/App Registration certificates. |
| ServerPassword | A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Application/App Registration certificates. If Client Certificate Auth is used, you must select 'No Value'. |
| ClientCertificate | The client certificate used to authenticate with Microsoft Graph for managing Application/App Registrations certificates. See the requirements for more information. If Client Certificate Auth is not used, you must check 'No Value'. |
| ClientCertificatePassword | The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used, you must check 'No Value'. |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
Azure Enterprise Application 2 (Service Principal) (AzureSP2)
Click to expand details
-
Navigate to the Certificate Stores page in Keyfactor Command.
Log into Keyfactor Command, toggle the Locations dropdown, and click Certificate Stores.
-
Add a Certificate Store.
Click the Add button to add a new Certificate Store. Use the table below to populate the Attributes in the Add form.
Attribute Description Category Select "Azure Enterprise Application 2 (Service Principal)" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine The Azure Tenant (directory) ID where the Service Principal is instantiated Store Path The Object ID of the target Service Principal/Enterprise Application that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension. Orchestrator Select an approved orchestrator capable of managing AzureSP2certificates. Specifically, one with theAzureSP2capability.ServerUsername The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. ServerPassword A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. If Client Certificate Auth is used, you must check 'No Value'. ClientCertificate The client certificate used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. See the requirements for more information. If Client Certificate Auth is not used, you must check 'No Value'. ClientCertificatePassword The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used or the certificate's private key is not encrypted, you must check 'No Value'. AzureCloud Specifies the Azure Cloud instance used by the organization.
Click to expand details
-
Generate a CSV template for the AzureSP2 certificate store
kfutil stores import generate-template --store-type-name AzureSP2 --outpath AzureSP2.csv
-
Populate the generated CSV file
Open the CSV file, and reference the table below to populate parameters for each Attribute.
Attribute Description Category Select "Azure Enterprise Application 2 (Service Principal)" or the customized certificate store name from the previous step. Container Optional container to associate certificate store with. Client Machine The Azure Tenant (directory) ID where the Service Principal is instantiated Store Path The Object ID of the target Service Principal/Enterprise Application that will be managed by the Azure App Registration and Enterprise Application Orchestrator extension. Orchestrator Select an approved orchestrator capable of managing AzureSP2certificates. Specifically, one with theAzureSP2capability.Properties.ServerUsername The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. Properties.ServerPassword A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. If Client Certificate Auth is used, you must check 'No Value'. Properties.ClientCertificate The client certificate used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. See the requirements for more information. If Client Certificate Auth is not used, you must check 'No Value'. Properties.ClientCertificatePassword The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used or the certificate's private key is not encrypted, you must check 'No Value'. Properties.AzureCloud Specifies the Azure Cloud instance used by the organization. -
Import the CSV file to create the certificate stores
kfutil stores import csv --store-type-name AzureSP2 --file AzureSP2.csv
Attributes eligible for retrieval by a PAM Provider on the Universal Orchestrator
If a PAM provider was installed on the Universal Orchestrator in the Installation section, the following parameters can be configured for retrieval on the Universal Orchestrator.
| Attribute | Description |
|---|---|
| ServerUsername | The Application ID of the Service Principal used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. |
| ServerPassword | A Client Secret that the extension will use to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. If Client Certificate Auth is used, you must check 'No Value'. |
| ClientCertificate | The client certificate used to authenticate with Microsoft Graph for managing Service Principal/Enterprise Application certificates. See the requirements for more information. If Client Certificate Auth is not used, you must check 'No Value'. |
| ClientCertificatePassword | The (optional) password that encrypts the private key in ClientCertificate. If Client Certificate Auth is not used or the certificate's private key is not encrypted, you must check 'No Value'. |
Please refer to the Universal Orchestrator (remote) usage section (PAM providers on the Keyfactor Integration Catalog) for your selected PAM provider for instructions on how to load attributes orchestrator-side.
Any secret can be rendered by a PAM provider installed on the Keyfactor Command server. The above parameters are specific to attributes that can be fetched by an installed PAM provider running on the Universal Orchestrator server itself.
The content in this section can be supplemented by the official Command documentation.
Discovery for all four Certificate Store Types implemented by the Azure App Registration and Enterprise
Application Orchestrator extension returns Store Paths in the format <guid> (<friendly name>). When defining
Certificate Stores manually, you may elect to follow this format, or use the standard <guid> for the Store Path.
The Discovery operation discovers all Azure App Registrations that the Service Principal has access to. The discovered App Registrations (specifically, their Application IDs) are reported back to Command and can be easily added as certificate stores from the Locations tab.
The Discovery operation uses the "Directories to search" field and accepts input in one of the following formats:
*- If the asterisk symbol*is used, the extension will search for all Azure App Registrations that the Service Principal has access to, but only in the tenant that the discovery job was configured for as specified by the "Client Machine" field in the certificate store configuration.<tenant-id>,<tenant-id>,...- If a comma-separated list of tenant IDs is used, the extension will search for all Azure App Registrations available in each tenant specified in the list. The tenant IDs should be the GUIDs associated with each tenant, and it's the user's responsibility to ensure that the service principal has access to the specified tenants.
Apache License 2.0, see LICENSE.