How to configure certificate based authentication in ServiceNow for Rest API

[Gayathri15]

Hi Team,

We have to Implement certificate based authentication in ServiceNow for Rest API. Could you please anybody help here.

[Kieran Anson]

Have you followed the docs? Set up Certificate-based authentication (servicenow.com)

[Community Alums]

Hi @Gayathri15 ,

Set up mutual authentication for either user interface-based logins or inbound web services.

Before you begin

Role required: admin

Check that your instance is using an ADCv2 load balancer. For more information, see theADCv2 Migration knowledge article. If your instance is not using the ADCv2 load balancer, contact Now Support.

Procedure

Set up Certificate-based authentication in order to:

• Allow end users to securely log in to the Now Platform or Service Portal using PIV or CAC cards. After certificate-based authentication is enabled, you can self-register the PEM certificate or an administrator can map the certificate for you. See Log in using Certificate-based authentication.
• Enable mutual authentication for inbound web services. Once Certificate-based authentication is set up, the system uses the provided certificates to mutually authenticate requests to access ServiceNow REST and SOAP APIs.

Activate Certificate-based authentication

You can activate the Certificate-based authentication plugin (com.glide.auth.mutual) for Now Platform if you have the admin role.

Before you begin

Role required: admin.

About this task

The following Tables are installed with Certificate-based authentication:

• sys_user_certificate
• sys_ca_certificate
• sys_ca_certificate_api_track

Procedure

1. Navigate to All > System Applications > All Available Applications > All.
2. Find the Certificate-based authentication plugin (com.glide.auth.mutual) using the filter criteria and search bar.

   You can search for the plugin by its name or ID. If you cannot find a plugin, you might have to request it from ServiceNow personnel.

3. Select Install, and then in the Activate Plugin dialog box, select Activate.
   Note: When domain separation and delegated admin are enabled in an instance, the administrative user must be in the global domain. Otherwise, the following error appears: Application installation is unavailable because another operation is running: Plugin Activation for <plugin name>.

Register CA certificate

Register root certificates or intermediate certificates to make them available for authentication.

Before you begin

Role required: admin

Procedure

1. Navigate to All > Certificate Based Authentication > CA Certificate Chain.
2. Click New.
3. On the form, fill in the fields:

   Mutual Auth CA Certificate form

   Field	Description
   Name	Name to identify the certificate.
   Expiration notification	Option to warn users when a certificate is about to expire.
   Notify on expiration	List of users to be notified when the certificate expires.
   Warn in days to expire	Number of days when a notification is sent to users before a certificate expires.
   Active	Option to make the client certificate active.
   Format	PEM
   Type	Type of certificate. Options include: CA Cert: The root CA certificate. Can also include intermediate certificates in the chain. CA certificates are automatically synced with the load balancer. Use this option when possible to avoid missing a required certificate in the chain. Intermediate Cert: An intermediate certificate in the certificate chain. This certificate remains on the instance only and is not synced with the load balancer. Only use this option if you need to add an intermediate certificate to an existing chain.
   Short description	Short description of the user client certificate.

   Note: During the certificate upload, the read-only fields, Valid from, Expires, Expires in days, Issuer, and Subject, Certificate Chain, and PEM Certificate are extracted and auto-populated.
4. Click Submit.
5. (Optional) Click Validate Stores/Certificates to validate the certificate.

Map PEM certificate to user

Map PEM certificates to users to enable them to log in using PIV or CAC cards or to authenticate inbound requests. You can map multiple PEM certificates to a user.

Before you begin

• Role required: admin
• Make sure that you have the Privacy Enhanced Mail (PEM) certificate of the user.

Note: After the Map PEM certificate to User configuration, the "verify certificate" will fail. This is because the PEM certificate is not stored.

Procedure

1. Navigate to All > Certificate Based Authentication > User to Certificate Mapping and click New.
2. On the form, fill in these fields:

   User Client Certificate form

   Field	Description
   Name	Name of the user client certificate.
   Expiration notification	Option to warn users when a certificate is about to expire.
   Warn in days to expire	Number of days when a notification is sent to users before a certificate expires.
   Notify on expiration	List of users to be notified when the certificate expires.
   Active	Option to make the client certificate active.
   User	User who is mapped to the client certificate. The system receives the client certificate from either the inbound request or certificate registration, and then uses the user designated in this field to initiate a session to execute the request.
   Short description	Short description of the user client certificate.
   Format	Privacy Enhanced Mail (PEM) format is a base-64 encoded Distinguished Encoding Rules (DER) certificate.
   Type	Client cert. This field is read only.

   Note: During the certificate upload, the read-only fields, Valid from, Expires, Expires in days, Issuer, and Subject are extracted and auto-populated.
3. Click the attachments icon and upload the certificate.
4. Click Submit.
   The certificate is validated and mapped to the specified user if the certificate is from a trusted Certificate Authority (CA).

Configure Certificate-based authentication properties

Use system properties to enable or disable certificate-based authentication features.

Before you begin

Role required: admin

Procedure

1. Navigate to All > Certificate Based Authentication > Properties.
2. On the form, fill in the fields:

   Certificate Based Authentication Properties form

   Property	Description
   Enable certificate based authentication	Option to enable to Certificate-based authentication for both user interface logins and inbound web services. Default: true
   Show 'Log in with PIV/CAC' option in login screen	Displays the Log in with PIV/CAC card option on the login screen. Allows users to log in using Certificate-based authentication using the user interface. Default: false
   Enable auto-redirect for certificate based login	Determines whether to require that the user click Log in with PIV/CAC card after selecting a registered certificate and entering their PIN. Activate to automatically log in the user after they select a registered client certificate and enter their PIN. Deactivate to require that the user click Log in with PIV/CAC card after they select a registered client certificate and enter their PIN. Default: false

[Kieran Anson]

What's the value of copying and pasting the entire docs page? Rather than linking to it?