REST API Access On Premise with SSO

book

Article ID: 208264

calendar_today

Updated On:

Products

Clarity PPM On Premise STARTER PACK-CLARITY PPM Clarity PPM SaaS

Issue/Introduction

Please provide guidance on how the REST APIs should be handled with SSO enabled for On Premise customers?

Environment

Release : Any

Component : CA PPM XML OPEN GATEWAY (XOG)

Resolution

If you're using SSO you must use Key-Based Authentication. Please check out the following steps:

1. See if you have followed all steps to enable Key Based Authentication here:

https://techdocs.broadcom.com/us/en/ca-enterprise-software/business-management/clarity-project-and-portfolio-management-ppm-on-premise/15-8-1/reference/Clarity-REST-APIs/REST-API-Authentication.html

Section Key-Based Authentication

2. Ensure you follow the instructions to use tokens as in section Using REST API Key in SSO Environments (On-Premise only)

3. Try also accessing the link as below with GET:

https://SERVERNAME:PORT/ppm/rest/v1/projects