Service Desk Integration › Service Desk Integration REST API Doc

Service Desk Integration REST API Doc

REST API documentation for NIM is available from within the CA Identity Manager user console.

Go to System, NIM SM Integration, and click View Service Desk Integration REST API Doc. In the frame that opens, you can view the model for each object type, and test API calls using the "Try it out!" button.

Note the following:

• To access the REST API Doc, make sure you browse using the full domain in the CA Identity Manager server URL. Example: Use http://myserver.domain.com:8080/iam/im/env, not http://myserver:8080/iam/im/env
• To use the "Try it out!" feature, you must enter your basic access authentication information in the HTTP Basic Authorization header field. This is just a standard basic authentication header.
  
  Example: in the basic authentication header "Basic bmltYWRtaW46bmltYWRtaW4=", bmltYWRtaW46bmltYWRtaW4= is simply “username:password” encoded in Base64.

NIM SM Web Service Details

To invoke the NIM Web Service, use the following URLs:

• Base URL:
  http://myserver.domain.com:[Server Port Number]/iam/imnimsm/api/v1
• Base URL (cluster deployment):
  http://localhost:[Server Port Number]/iam/imnimsm/api/v1 as the base URL.
• To access specific APIs, add the name at the end of the URL.
  Example: To access the Incident API, use this URL:
  http://myserver.domain.com:[Server Port Number]/iam/imnimsm/api/v1/incident

The NIM Web Service uses HTTP Basic Authentication and the credentials are the username and password provided for CA embedded components during a fresh install, or the updated credentials that you set post upgrade.