Administrative Token API
 – Obtain a JSON Web Token (JWT) that is 
required
 to access the Policy Data API and Policy Migration API.
 
Policy Data API
 – Create, read, update, and delete objects (including federation entities, federation partnerships, and certificate services) in the policy store.
 
Policy Migration API
 – Export and import specified subsets of the policy data in the policy store.

https://
adminui_host:8443/
call_address

/ca/api/sso/services

 https://adminui.example.com:8443/ca/api/sso/services/login/v1/token

https://
adminui_host:8443/ca/api/sso/services/v1/api-doc/

Causes a browser security warning when accessing the reference documentation in Google Chrome.
Prevents Chrome-based API development apps (such as Postman) from accessing the REST APIs.
Prevents Java applications from accessing the REST APIs.

In Chrome, open the root URL for the server (for example 
https://adminui.example.com:8443/
).
A warning page appears, stating that “Your connection is not private.”
Select 
ADVANCED
 
Select 
Proceed to https://
yourserver
:
port 
(unsafe)
. For example, "Proceed to https://adminui.example.com:8443 (unsafe).”

In Chrome, open the root URL for the server (for example
https://adminui.example.com:8443/
).
A warning page appears, stating that “Your connection is not private.”
Enter 
F12
 to access the developer tools
On the 
Security
 tab, select 
View Certificate
.
On the 
Details
 tab, select 
Copy to File
 and Save the file
In Chrome, open 
chrome://settings/
.
Select 
Show advanced settings
.
In the 
HTTPS/SSL
 section, select 
Manage Certificates
.
Import the self-signed certificate file that you saved in Step 4. to the 
Trusted Root Certification Authorities
 certificate store.
Restart Chrome.

Disable certificate validation (less secure)
Export the certificate from your browser and import it in your JVM truststore (to establish a chain of trust).

Combine the username and password with a single colon (:) symbol. For example:

sso_admin:sso_password

Encode this string using Base64. For the example in Step 1, Base64-encoding results in the following string: 

c3NvX2FkbWluOnNzb19wYXNzd29yZA==

Precede the encoded result with "Basic ". For example:

Basic c3NvX2FkbWluK3Nzb19wYXNzd29yZA==

/ca/api/sso/services

Basic c3NvX2FkbWluK3Nzb19wYXNzd29yZA==

{
  "sessionkey: "
JWT_Token"
}

{
"sessionkey": "eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiZGlyIn0..XzXFIuc8hltEbTx2.mUe9UmyNwkUapkL2vMU86GsIIV2aYwRRmaZoGZpoHhX6d3a8vxXe7p4z_fwcFkm2jt1GvurR00wDSrm3gqGHjWRguP1ZHeoN_L_tkoYCIyS7zG_nClZEtjn4DL2C70wM87moAayJ7YTlz66oKVoNBl6qh5o425pejFc3dsefL0zNdAw6fvRySFEE-7j_FcjsnobTt5XT8RqTu--iYzKH9u2D7_yobQzbFF8ol1vAVNZpcZDrfTOoVMSbAI5RTo7Y9ux7GEcGEhNOOl3546j2ay3ikpaWUO14HUf9l5foU6s0IjZ1IWgX0cPwUJYGsWl4eupH6_fD6KdUtfQmfpwz_WPk2iWpdGJGE5JpeersJLCCcb98Rm3DREm_rXVH2p-XJaeQsHKHSxkZynTHIGBltn8e0xeD7FOirfUHWPzZPVQ5W_HdDETrALW8g-XmdQebxpUgtDpxeAEtjt4pw-sK25XiRzGmgwbV4lBiHKgrXeU0YlKtn1bUtsISRScDOcJEFB4niSrjgtrzsEg-riymdbst37H_tPUM1jIy3tGV.LZHHUgHm5fNIRK6JiCarqw"
}

/ca/api/sso/services/

Bearer eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiZGlyIn0..XzXFIuc8hltEbTx2.mUe9UmyNwkUapkL2vMU86GsIIV2aYwRRmaZoGZpoHhX6d3a8vxXe7p4z_fwcFkm2jt1GvurR00wDSrm3gqGHjWRguP1ZHeoN_L_tkoYCIyS7zG_nClZEtjn4DL2C70wM87moAayJ7YTlz66oKVoNBl6qh5o425pejFc3dsefL0zNdAw6fvRySFEE-7j_FcjsnobTt5XT8RqTu--iYzKH9u2D7_yobQzbFF8ol1vAVNZpcZDrfTOoVMSbAI5RTo7Y9ux7GEcGEhNOOl3546j2ay3ikpaWUO14HUf9l5foU6s0IjZ1IWgX0cPwUJYGsWl4eupH6_fD6KdUtfQmfpwz_WPk2iWpdGJGE5JpeersJLCCcb98Rm3DREm_rXVH2p-XJaeQsHKHSxkZynTHIGBltn8e0xeD7FOirfUHWPzZPVQ5W_HdDETrALW8g-XmdQebxpUgtDpxeAEtjt4pw-sK25XiRzGmgwbV4lBiHKgrXeU0YlKtn1bUtsISRScDOcJEFB4niSrjgtrzsEg-riymdbst37H_tPUM1jIy3tGV.LZHHUgHm5fNIRK6JiCarqw"

SmAgents
SmAuthSchemes
SmDomains
SmUserDirectories

/ca/api/sso/services/

SmAgents
SmAuthSchemes
SmDomains
SmUserDirectories

adminui.

?filter=
attribute operator value

(enumeration): ?filter=Mode contains GlobalPoliciesApply
(boolean): ?filter=IsAffiliate = true
(string): ?filter=Name endswith 'abc'
(integer): ?filter=IdleTimout < 1000
(null): ?filter=desc != null

not Name contains 'a' and Name contains 'b'

name contains 'a' or name contains 'b' and name contains 'c'

https://example.com:8443/ca/api/sso/services/policy/v1/smdomains?filter=Mode contains GlobalPoliciesApply
https://example.com:8443/ca/api/sso/services/policy/v1/smdomains?filter=IsAffiliate=true
https://example.com:8443/ca/api/sso/services/policy/v1/smagents?filter=Name endswith 'abc'
https://example.com:8443/ca/api/sso/services/policy/v1/smrealms?filter=IdleTimeout<1000
https://example.com:8443/ca/api/sso/services/policy/v1/smauthschemes?filter=desc != null
https://example.com:8443/ca/api/sso/services/policy/v1/smpolicies?filter=not Name contains 'a' and Name contains 'b'
https://example.com:8443/ca/api/sso/services/policy/v1/smrealms?filter=name contains 'a' or name contains 'b' and name contains 'c'

Bearer 
JWT_Token

/ca/api/sso/services/

adminui.

Bearer 
JWT_Token

{
  "responseType": "object",
  "data": {
    "id": "CA.SM::Domain@03-2dc3c12c-8bf4-4d32-a1f7-f18e913233d5",
    "type": "SmDomain",
    "Name": "FedBackChannelBasicDomain",
    "Mode": [],
    "IsAffiliate": false,
    "HidingMask": [
      "GUI"
    ],
    "UserDirectoriesLink": [
      {
        "id": "CA.SM::UserDirectory@0e-f741be64-b38b-4d98-a431-b96548214981",
        "path": "/SmUserDirectories/FedBCCustomUserStore",
        "href": "https://adminui.example.com:8443/ca/api/sso/services/policy/v1/objects/CA.SM::UserDirectory@0e-f741be64-b38b-4d98-a431-b96548214981",
        "desc": "Custom user store for Federation BackChannel communications"
      }
    ]
  },
  "links": {
    "self": {
      "href": "https://adminui.example.com:8443/ca/api/sso/services/policy/v1/objects/CA.SM::Domain@03-2dc3c12c-8bf4-4d32-a1f7-f18e913233d5"
    },
    "relatedobj": {
      "href": "https://adminui.example.com:8443/ca/api/sso/services/policy/v1/objects/CA.SM::Domain@03-2dc3c12c-8bf4-4d32-a1f7-f18e913233d5/relatedobj"
    },
    "children": {
      "href": "https://adminui.example.com:8443/ca/api/sso/services/policy/v1/objects/CA.SM::Domain@03-2dc3c12c-8bf4-4d32-a1f7-f18e913233d5/children"
    },
    "expanded": {
      "href": "https://adminui.example.com:8443/ca/api/sso/services/policy/v1/objects/CA.SM::Domain@03-2dc3c12c-8bf4-4d32-a1f7-f18e913233d5?op=expanded"
    },
    "usedby": {
      "href": "https://adminui.example.com:8443/ca/api/sso/services/policy/v1/objects/CA.SM::Domain@03-2dc3c12c-8bf4-4d32-a1f7-f18e913233d5/usedby"
    },
    "classinfo": {
      "href": "https://adminui.example.com:8443/ca/api/sso/services/policy/v1/objects/CA.SM::Domain@03-2dc3c12c-8bf4-4d32-a1f7-f18e913233d5/classinfo"
    },
    "editinfo": {
      "href": "https://adminui.example.com:8443/ca/api/sso/services/policy/v1/objects/CA.SM::Domain@03-2dc3c12c-8bf4-4d32-a1f7-f18e913233d5?op=editinfo"
    }
  }
}

/ca/api/sso/services/policy/v1/objects/

adminui.

Bearer 
JWT_Token

/ca/api/sso/services/policy/v1/objects/

adminui.

Bearer 
JWT_Token

Bearer 
JWT_Token

/ca/api/sso/services/

PKCS8 and PKCS12 formats need password.
PKCS8 can export only private key.
A password is required only if the private key is encrypted.

/ca/api/sso/services/policy/v1/FedCertificate
/aliasName

Perform a granular export of a specified subset of your policy data
Import previously exported policy data

Bearer eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiZGlyIn0..XzXFIuc8hltEbTx2.mUe9UmyNwkUapkL2vMU86GsIIV2aYwRRmaZoGZpoHhX6d3a8vxXe7p4z_fwcFkm2jt1GvurR00wDSrm3gqGHjWRguP1ZHeoN_L_tkoYCIyS7zG_nClZEtjn4DL2C70wM87moAayJ7YTlz66oKVoNBl6qh5o425pejFc3dsefL0zNdAw6fvRySFEE-7j_FcjsnobTt5XT8RqTu--iYzKH9u2D7_yobQzbFF8ol1vAVNZpcZDrfTOoVMSbAI5RTo7Y9ux7GEcGEhNOOl3546j2ay3ikpaWUO14HUf9l5foU6s0IjZ1IWgX0cPwUJYGsWl4eupH6_fD6KdUtfQmfpwz_WPk2iWpdGJGE5JpeersJLCCcb98Rm3DREm_rXVH2p-XJaeQsHKHSxkZynTHIGBltn8e0xeD7FOirfUHWPzZPVQ5W_HdDETrALW8g-XmdQebxpUgtDpxeAEtjt4pw-sK25XiRzGmgwbV4lBiHKgrXeU0YlKtn1bUtsISRScDOcJEFB4niSrjgtrzsEg-riymdbst37H_tPUM1jIy3tGV.LZHHUgHm5fNIRK6JiCarqw"

 
mainObjectsMethod
 – Specifies how the policy data for explicitly exported objects behaves when imported. Use one of the following options:
 
ADD
 – Only new policy data is added to the target policy store during import.
 
OVERLAY
 – If the object already exists in the target store, it is updated with only the latest changes from the exported data during import.
 
REPLACE
 – If the object already exists in the target store, it is overwritten with the exported data during import.
closureObjectsMethod
 – 
Specifies how the system objects related to exported policy objects behave when imported. System objects that are related to a specified object are automatically included when an object is exported. For example, a referenced agent is also exported when a domain is exported. Use one of the following options:
 
ADD 
– Only new system objects are added to the target policy store during import.
 
OVERLAY
 – If a related system object already exists in the target store, it is updated with only the latest changes from the exported data during import.
 
REPLACE
 – If a related system object already exists in the target store, it is overwritten with the exported data during import.
 
passPhrase
 – Specifies a passphrase to use to encrypt the export data. This passphrase must be at least eight characters long and must contain at least one digit, one uppercase, and one lowercase character. The passphrase can contain a space that is enclosed in quotes.
 
suggestedFileName
 – Specifies a filename that is returned as an attachment in the Content-Disposition response header.
 
objects – 
Specifies an array of paths of root policy objects to export. Each specified object takes the following form:
"path":"
Policy_Data_API_object_reference"
 
Where Policy_Data_API_object_reference
 is the same that would appear in a Policy Data API call to retrieve an object. For example, if the URL of a call to retrieve an object is 
 
https://hostname
 
:8443/ca/api/sso/services/policy/v1/smdomains/FedBackChannelBasicDomain, the path reference is "smdomains/FedBackChannelBasicDomain."

{
    "mainObjectsMethod":"ADD",
    "closureObjectsMethod":"ADD",
    "passPhrase":"PassPhrase",
    "suggestedFileName":"output.xml",
    "objects":[
        {"path":"SmDomains/FedBackChannelBasicDomain"},
        {"path":"smagenttypes/Web Agent"}
    ]
}

Bearer eyJlbmMiOiJBMTI4R0NNIiwiYWxnIjoiZGlyIn0..XzXFIuc8hltEbTx2.mUe9UmyNwkUapkL2vMU86GsIIV2aYwRRmaZoGZpoHhX6d3a8vxXe7p4z_fwcFkm2jt1GvurR00wDSrm3gqGHjWRguP1ZHeoN_L_tkoYCIyS7zG_nClZEtjn4DL2C70wM87moAayJ7YTlz66oKVoNBl6qh5o425pejFc3dsefL0zNdAw6fvRySFEE-7j_FcjsnobTt5XT8RqTu--iYzKH9u2D7_yobQzbFF8ol1vAVNZpcZDrfTOoVMSbAI5RTo7Y9ux7GEcGEhNOOl3546j2ay3ikpaWUO14HUf9l5foU6s0IjZ1IWgX0cPwUJYGsWl4eupH6_fD6KdUtfQmfpwz_WPk2iWpdGJGE5JpeersJLCCcb98Rm3DREm_rXVH2p-XJaeQsHKHSxkZynTHIGBltn8e0xeD7FOirfUHWPzZPVQ5W_HdDETrALW8g-XmdQebxpUgtDpxeAEtjt4pw-sK25XiRzGmgwbV4lBiHKgrXeU0YlKtn1bUtsISRScDOcJEFB4niSrjgtrzsEg-riymdbst37H_tPUM1jIy3tGV.LZHHUgHm5fNIRK6JiCarqw"

Passphrase1
<?xml version="1.0" encoding="UTF-8"?>
<XPS xmlns:xs="http://www.w3.org/2001/XMLSchema-instance"
    xs:noNamespaceSchemaLocation="CA_SiteMinder_WAM-XPS2.xsd">
    <XPSVersion>1</XPSVersion>
    <HostInformation>BASKETVM14</HostInformation>
    <XPSAdmin>siteminder [SM://12027584-3240-4ef5-b188-148d88a48cda/siteminder]</XPSAdmin>
    <PolicyData IsDumpExport="false">
        … Export Data…
    </PolicyData>
</XPS>

JavaScript Policy Browser Sample
Java Migration Sample

SDK_Install_dir\samples64\restapi\browser

C:\Program Files\CA\sdk\samples64\restapi\browser

SDK_Install_dir\samples64\restapi\basic

C:\Program Files\CA\sdk\samples64\restapi\basic