Through JavaScript

To set up OAuth-based authentication and authorization with Microsoft Entra using JavaScript through the Query Console, follow these steps:

1. Create the external security object by executing code like this:

   Note:
   
   The JWT Secrets field secures both symmetric and asymmetric signature keys.

   Note:
   
   You can specify a JWKS URI to validate incoming JWT access tokens with JWKS instead of with JWT Secrets signature keys.

   Note:
   
   The parameters oauthAuthorizationServerUri, oauthTokenServerUri, oauthRedirectUri, oauthScope, oauthClientAuthenticationMethod, and oauthClientSecret are required only when using the Authorization code flow. These parameters configure the MarkLogic app server to act as an OAuth client. They are not needed for the Resource server flow.

   Resource server flow

   Copy

   declareUpdate();
   const sec = require('/MarkLogic/security');
   
   const oauthVendor = "Microsoft Entra";
   const oauthFlowType = "Resource server";
   const oauthClientId = "37b06574-bdf0-42a2-9659-ebeaf8faf1c6";
   const oauthTokenType = "JSON Web Tokens";
   const oauthUsernameAttribute = "name";
   const oauthRoleAttribute = "groups";
   const oauthJWTIssuerUri = "https://sts.windows.net/3fc33f01-1894-4196-b81f-54417daac155/";
   const oauthJWTAlg = "RS256";
   const oauthJWTKeyIds = "XRvko8P7A3UaWSnU7bM9nT0MjhA";
   const oauthJWTSecretValues = "-----BEGIN PUBLIC KEY-----<PEM-converted RS256 Secret Value>-----END PUBLIC KEY-----";
   
   const oauth = sec.oauthServer(
   oauthVendor,
   oauthFlowType,
   oauthClientId,
   oauthTokenType,
   oauthUsernameAttribute,
   oauthRoleAttribute,
   "",
   oauthJWTIssuerUri,
   oauthJWTAlg,
   oauthJWTKeyIds,
   oauthJWTSecretValues
   );
   
   sec.createExternalSecurity(
   "MicrosoftEntraExampleOAuth",
   "Microsoft Entra external security object for OAuth",
   "oauth",
   300,
   "oauth",
   null,
   null,
   oauth);
   

   Authorization code flow

   Copy

   declareUpdate();
   const sec = require('/MarkLogic/security');
   
   const oauthVendor = "Microsoft Entra";
   const oauthFlowType = "Authorization code";
   const oauthClientId = "<application-client-id>";
   const oauthTokenType = "JSON Web Tokens";
   const oauthUsernameAttribute = "name";
   const oauthRoleAttribute = "groups";
   const oauthJWTIssuerUri = "<jwt-issuer-uri>";
   const oauthJWTAlg = "RS256";
   const oauthJWTKeyIds = "<key-id>";
   const oauthJWTSecretValues = "-----BEGIN PUBLIC KEY-----<PEM-converted key>-----END PUBLIC KEY-----";
   const oauthJwksUri = "";
   const oauthAuthorizationServerUri = "<oauth-server-authorize-endpoint>";
   const oauthTokenServerUri = "<oauth-server-token-endpoint>";
   const oauthRedirectUri = "https://<marklogic-host>:<app-server-port>";
   const oauthScope = "openid profile";
   const oauthClientAuthenticationMethod = "Client secret";
   const oauthClientSecret = "<client-secret-value>";
   
   const oauth = sec.oauthServer(
   oauthVendor,
   oauthFlowType,
   oauthClientId,
   oauthTokenType,
   oauthUsernameAttribute,
   oauthRoleAttribute,
   "",
   oauthJWTIssuerUri,
   oauthJWTAlg,
   oauthJWTKeyIds,
   oauthJWTSecretValues,
   oauthJwksUri,
   oauthAuthorizationServerUri,
   oauthTokenServerUri,
   oauthRedirectUri,
   oauthScope,
   oauthClientAuthenticationMethod,
   oauthClientSecret
   );
   
   sec.createExternalSecurity(
   "MicrosoftEntraExampleOAuthClient",
   "Microsoft Entra external security object for OAuth Authorization Code flow",
   "oauth",
   300,
   "oauth",
   null,
   null,
   oauth);
   

2. Create any HTTP, XDBC, WebDAV, or ODBC app servers that you wish to configure with this external security object.

3. Configure your app servers to use this external security object with code like this:

   Copy

   declareUpdate();
   const admin = require('/MarkLogic/admin.xqy');
   const config = admin.getConfiguration();
   const groupid = admin.groupGetId(config, "Default");
   const appserver = "<app server name>";
   const extsec = "<external security object name>";
   
   admin.saveConfiguration(admin.appserverSetExternalSecurity(config, groupid, admin.appServerGetId(config, appserver), extsec, fn.false(), "oauth"));
   

4. Assign external names to your desired roles with code like this:

   Copy

   declareUpdate();
   const sec = require('/MarkLogic/security.xqy');
   
   const roleName = "<MarkLogic Server role name, for example, manage-user>";
   const externalName = "7228762e-cb30-428a-ae1a-3a8cf9e2f728";
   sec.roleSetExternalNames(roleName, externalName);
   

MarkLogic Server is now set up for OAuth-based authentication and authorization with Microsoft Entra.