Through the REST API

To set up SAML-based authentication and authorization with PingOne through the REST API, follow these steps:

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

   JavaScript/JSON

   Copy

   curl -X POST --anyauth -k -u <username>:<password> -H "Content-Type:application/json" \ 
   -d @create_extsec.json http://<machine URI>:8002/manage/v2/external-security
   

   Contents of create_extsec.json

   Copy

   {
     "external-security-name": "PingOne-SAML",
     "description": "PingOne external security object for SAML",
     "authentication": "saml",
     "cache-timeout": 300,
     "authorization": "saml",
     "saml-server": {
       "saml-entity-id": "http://localhost:8010/",
       "saml-attribute-name": [
         "group"
       ],
       "saml-destination": "https://auth.pingone.asia/a58...3c8/saml20/idp/sso",
       "saml-issuer": "http://localhost:8010/",
       "saml-idp-certificate-authority": "-----BEGIN CERTIFICATE----- MII...qY= -----END CERTIFICATE-----"
     }
   }
   

   XQuery/XML

   Copy

   curl -X POST --anyauth -k -u <username>:<password> -H "Content-Type:application/xml" \ 
   -d @create_extsec.xml http://<machine URI>:8002/manage/v2/external-security
   

   Contents of create_extsec.xml

   Copy

   <external-security-properties xmlns="http://marklogic.com/manage">
     <external-security-name>PingOne-SAML</external-security-name>
     <description>PingOne external security object for SAML</description>
     <authentication>saml</authentication>
     <cache-timeout>300</cache-timeout>
     <authorization>saml</authorization>
     <saml-server>
       <saml-entity-id>http://localhost:8010/</saml-entity-id>
       <saml-attribute-names>
         <saml-attribute-name>group</saml-attribute-name>
       </saml-attribute-names>
       <saml-destination>https://auth.pingone.asia/a58...3c8/saml20/idp/sso</saml-destination>
       <saml-issuer>http://localhost:8010/</saml-issuer>
       <saml-idp-certificate-authority>-----BEGIN CERTIFICATE----- MII...qY= -----END CERTIFICATE-----</saml-idp-certificate-authority>
     </saml-server>
   </external-security-properties>
   

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:

   JSON application

   Copy

   curl -X PUT --anyauth -k -u <username>:<password> \
     -H "Content-type:application/json" \
     -d '{
           "external-security": "PingOne-SAML",
           "internal-security": false,
           "authentication": "saml"
         }' \
     http://<machine URI>:8002/manage/v2/servers/<app server name>/properties?group-id=Default
   

   XML application

   Copy

   curl -X PUT --anyauth -k -u admin:admin \
     -H "Content-type:application/xml" \
     -d '<http-server-properties xmlns="http://marklogic.com/manage">
           <external-security>PingOne-SAML</external-security>
           <internal-security>false</internal-security>
           <authentication>saml</authentication>
         </http-server-properties>' \
     http://<machine URI>:8002/manage/v2/servers/<app server name>/properties?group-id=Default
   
   

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

   JSON application

   Copy

   curl -X PUT --anyauth -k -u <username>:<password> \
     -H "Content-type:application/json" \
     -d '{"external-name": "dh-admin"}' \
     http://<machine URI>:8002/manage/v2/roles/<MarkLogic Server role name like manage-user>/properties
   

   XML application

   Copy

   curl -X PUT --anyauth -k -u <username>:<password> \
     -H "Content-type:application/xml" \
     -d '<role-properties xmlns="http://marklogic.com/manage/role/properties">
           <external-names>
             <external-name>dh-admin</external-name>
           </external-names>
         </role-properties>' \
     http://<machine URI>:8002/manage/v2/roles/<MarkLogic Server role name like manage-user>/properties
   

MarkLogic Server is now set up for SAML-based authentication and authorization with PingOne.