Through XQuery

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

1. Create the external security object with code like this:

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

   Note:
   
   If you are using an asymmetric algorithm, then you can specify a JWKS URI to validate incoming JWT access tokens with JWKS instead of with JWT Secrets signature keys.

   Note:
   
   The parameters $oauth-authorization-server-uri, $oauth-token-server-uri, $oauth-redirect-uri, $oauth-scope, $oauth-client-authentication-method, and $oauth-client-secret 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

   xquery version "1.0";
   import module namespace sec = "http://marklogic.com/xdmp/security" at "/MarkLogic/security.xqy";
   
   let $oauth-vendor := "Ping Identity",
   $oauth-flow-type := "Resource server",
   $oauth-client-id := "PingExampleClientID",
   $oauth-token-type := "JSON Web Tokens",
   $oauth-username-attribute := "username",
   $oauth-role-attribute := "roles",
   $oauth-privilege-attribute := "privileges",
   $oauth-jwt-alg := "RS256",
   $oauth-jwt-key-ids := "PingExampleKeyID",
   $oauth-jwt-secret-values := "<RS256 JWT Secret Value>",
   $oauth-jwks-uri := "https://localhost/pf/JWKS"
   
   let $oauth := sec:oauth-server(
   $oauth-vendor,
   $oauth-flow-type,
   $oauth-client-id,
   $oauth-token-type, 
   $oauth-username-attribute,
   $oauth-role-attribute,
   $oauth-privilege-attribute,
   (),
   $oauth-jwt-alg,
   $oauth-jwt-key-ids,
   $oauth-jwt-secret-values,
   $oauth-jwks-uri)
   
   return sec:create-external-security(
   'PingIdentityExampleOAuth',
   'PingIdentity external security object for OAuth',
   'oauth',
   300,
   'oauth',
   (),
   (),
   $oauth)
   

   Authorization code flow

   Copy

   xquery version "1.0";
   import module namespace sec = "http://marklogic.com/xdmp/security" at "/MarkLogic/security.xqy";
   
   let $oauth-vendor := "Ping Identity",
   $oauth-flow-type := "Authorization code",
   $oauth-client-id := "<application-client-id>",
   $oauth-token-type := "JSON Web Tokens",
   $oauth-username-attribute := "username",
   $oauth-role-attribute := "roles",
   $oauth-privilege-attribute := "privileges",
   $oauth-jwt-issuer-uri := "<jwt-issuer-uri>",
   $oauth-jwt-alg := "RS256",
   $oauth-jwt-key-ids := "<key-id>",
   $oauth-jwt-secret-values := "<RS256 JWT Secret Value>",
   $oauth-jwks-uri := "https://localhost/pf/JWKS",
   $oauth-authorization-server-uri := "<oauth-server-authorize-endpoint>",
   $oauth-token-server-uri := "<oauth-server-token-endpoint>",
   $oauth-redirect-uri := "https://<marklogic-host>:<app-server-port>",
   $oauth-scope := "openid profile",
   $oauth-client-authentication-method := "Client secret",
   $oauth-client-secret := "<client-secret-value>"
   
   let $oauth := sec:oauth-server(
   $oauth-vendor,
   $oauth-flow-type,
   $oauth-client-id,
   $oauth-token-type,
   $oauth-username-attribute,
   $oauth-role-attribute,
   $oauth-privilege-attribute,
   $oauth-jwt-issuer-uri,
   $oauth-jwt-alg,
   $oauth-jwt-key-ids,
   $oauth-jwt-secret-values,
   $oauth-jwks-uri,
   $oauth-authorization-server-uri,
   $oauth-token-server-uri,
   $oauth-redirect-uri,
   $oauth-scope,
   $oauth-client-authentication-method,
   $oauth-client-secret)
   
   return sec:create-external-security(
   'PingIdentityExampleOAuthClient',
   'PingIdentity external security object for OAuth Authorization Code flow',
   'oauth',
   300,
   'oauth',
   (),
   (),
   $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

   xquery version "1.0-ml";
   import module namespace admin = "http://marklogic.com/xdmp/admin" at "/MarkLogic/admin.xqy";
   
   let $config := admin:get-configuration()
   let $groupid := admin:group-get-id($config, "Default")
   let $appserver := <app server name>
   let $extsec := "PingIdentityExampleOAuth"
   
   return admin:save-configuration(admin:appserver-set-external-security($config, admin:appserver-get-id($config, $groupid, $appserver), $extsec, fn:false(), "oauth"))
   

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

   Note:
   
   The external names are the values returned under the role attribute of the access token payload.

   Copy

   xquery version "1.0-ml";
   import module namespace sec = "http://marklogic.com/xdmp/security" at "/MarkLogic/security.xqy";
   
   let $role-name := <MarkLogic Server role name like "manage-user">
   let $external-name := "external-user-role"
   return sec:role-set-external-names($role-name, $external-name)
   

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