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, Client Secret authentication is 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.

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.

Creating and Formatting a Client Certificate using Keyfactor Command

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.

1. In Keyfactor Command, hover over Enrollment and select PFX Enrollment.
2. Select a Template that supports Client Authentication as an extended key usage.
3. Populate the certificate subject as appropriate for the Template. It may be sufficient to only populate the Common Name, but consult your IT policy to ensure that this certificate is compliant.
4. At the bottom of the page, uncheck the box for Include Chain, and select either PFX or PEM as the certificate Format.
5. Make a note of the password on the next page - it won't be shown again.
6. 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

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

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.

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, Client Secret authentication is 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.

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.

Creating and Formatting a Client Certificate using Keyfactor Command

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.

1. In Keyfactor Command, hover over Enrollment and select PFX Enrollment.
2. Select a Template that supports Client Authentication as an extended key usage.
3. Populate the certificate subject as appropriate for the Template. It may be sufficient to only populate the Common Name, but consult your IT policy to ensure that this certificate is compliant.
4. At the bottom of the page, uncheck the box for Include Chain, and select either PFX or PEM as the certificate Format.
5. Make a note of the password on the next page - it won't be shown again.
6. 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

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

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 of this extension, please see the mechanics section.