Cognos Analytics

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUxDUmJHb293dTRLREZDNGtmNmFKYUphdnBNcjhWbU5BeGJBVUVKeERnbmw0NTA0nM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}
I tried out on https://<cognos_analytics_server>:<port>/api/api-docs.
But rin api-docs,they mentioned about logEnabled:true,canCallLogon=true.
Is it wrong response.
And After session created i am getting on next request by passing xsrf token
{ "message": "Authentication required." }
Thanks!
----------
Amol
----------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUxDUmJHb293dTRLREZDNGtmNmFKYUphdnBNcjhWbU5BeGJBVUVKeERnbmw0NTA0nM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}
I tried out on https://<cognos_analytics_server>:<port>/api/api-docs.
But rin api-docs,they mentioned about logEnabled:true,canCallLogon=true.
Is it wrong response.
And After session created i am getting on next request by passing xsrf token
{ "message": "Authentication required." }
Thanks!
----------
Amol
----------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUp6M2d6VXlUeWplNEdkVXk3cTBiUEo1S2IwOG1NR2xNS3dHQmNkamE4Kno0MTV8cnM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}
Response headers

 cache-control: no-cache  content-language: en-US  content-length: 302  content-type: application/json
 date: Thu, 20 May 2021 07:37:51 GMT
 expires: Thu, 01 Jan 1970 00:00:00 GMT
 x-ca-affinity: 3526048407
 x-ca-requesttime: path=session; start=1621496271093; end=1621496271177; elapsed=84
 x-ca-transaction: C9dGh9jqhGsClMdsM2h8ysMlMMvqhj9hl4Mhh 

Thanks!
---------
Amol
---------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

Sorry, that was my misunderstanding!! :-) I have the same JSON response.

XSRF-Token is part of cookies. You have to get this value from session headers. How to do that depends on your implementation. If you are using swagger from https://<cognos_analytics_server>:<port>/api/api-docs you can check it directly in your browser.

1.In Chrome/Edge (on Chromium) use shortcut CTRL + SHIFT + I. Developer console will open.
2. In developer Console, go to network tab
3. On Swagger, execute PUT request to create session
4. In Developer Console, on network tab new Cookies tab should be available. Here you can see your XSRF-Token cookie and its value. 

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUp6M2d6VXlUeWplNEdkVXk3cTBiUEo1S2IwOG1NR2xNS3dHQmNkamE4Kno0MTV8cnM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}
Response headers

 cache-control: no-cache  content-language: en-US  content-length: 302  content-type: application/json
 date: Thu, 20 May 2021 07:37:51 GMT
 expires: Thu, 01 Jan 1970 00:00:00 GMT
 x-ca-affinity: 3526048407
 x-ca-requesttime: path=session; start=1621496271093; end=1621496271177; elapsed=84
 x-ca-transaction: C9dGh9jqhGsClMdsM2h8ysMlMMvqhj9hl4Mhh 

Thanks!
---------
Amol
---------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

{"message":"Authentication required."}

Sorry, that was my misunderstanding!! :-) I have the same JSON response.

XSRF-Token is part of cookies. You have to get this value from session headers. How to do that depends on your implementation. If you are using swagger from https://<cognos_analytics_server>:<port>/api/api-docs you can check it directly in your browser.

1.In Chrome/Edge (on Chromium) use shortcut CTRL + SHIFT + I. Developer console will open.
2. In developer Console, go to network tab
3. On Swagger, execute PUT request to create session
4. In Developer Console, on network tab new Cookies tab should be available. Here you can see your XSRF-Token cookie and its value. 

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUp6M2d6VXlUeWplNEdkVXk3cTBiUEo1S2IwOG1NR2xNS3dHQmNkamE4Kno0MTV8cnM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}
Response headers

 cache-control: no-cache  content-language: en-US  content-length: 302  content-type: application/json
 date: Thu, 20 May 2021 07:37:51 GMT
 expires: Thu, 01 Jan 1970 00:00:00 GMT
 x-ca-affinity: 3526048407
 x-ca-requesttime: path=session; start=1621496271093; end=1621496271177; elapsed=84
 x-ca-transaction: C9dGh9jqhGsClMdsM2h8ysMlMMvqhj9hl4Mhh 

Thanks!
---------
Amol
---------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

{"message":"Authentication required."}

Sorry, that was my misunderstanding!! :-) I have the same JSON response.

XSRF-Token is part of cookies. You have to get this value from session headers. How to do that depends on your implementation. If you are using swagger from https://<cognos_analytics_server>:<port>/api/api-docs you can check it directly in your browser.

1.In Chrome/Edge (on Chromium) use shortcut CTRL + SHIFT + I. Developer console will open.
2. In developer Console, go to network tab
3. On Swagger, execute PUT request to create session
4. In Developer Console, on network tab new Cookies tab should be available. Here you can see your XSRF-Token cookie and its value. 

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUp6M2d6VXlUeWplNEdkVXk3cTBiUEo1S2IwOG1NR2xNS3dHQmNkamE4Kno0MTV8cnM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}
Response headers

 cache-control: no-cache  content-language: en-US  content-length: 302  content-type: application/json
 date: Thu, 20 May 2021 07:37:51 GMT
 expires: Thu, 01 Jan 1970 00:00:00 GMT
 x-ca-affinity: 3526048407
 x-ca-requesttime: path=session; start=1621496271093; end=1621496271177; elapsed=84
 x-ca-transaction: C9dGh9jqhGsClMdsM2h8ysMlMMvqhj9hl4Mhh 

Thanks!
---------
Amol
---------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

Is it correct response?
After that, i am going for GET request, using all session cookies in params and xsrf- token in the header sesction.

Still i am getting

"message": "Authentication required."
Please check all screenshots

{"message":"Authentication required."}

Sorry, that was my misunderstanding!! :-) I have the same JSON response.

XSRF-Token is part of cookies. You have to get this value from session headers. How to do that depends on your implementation. If you are using swagger from https://<cognos_analytics_server>:<port>/api/api-docs you can check it directly in your browser.

1.In Chrome/Edge (on Chromium) use shortcut CTRL + SHIFT + I. Developer console will open.
2. In developer Console, go to network tab
3. On Swagger, execute PUT request to create session
4. In Developer Console, on network tab new Cookies tab should be available. Here you can see your XSRF-Token cookie and its value. 

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUp6M2d6VXlUeWplNEdkVXk3cTBiUEo1S2IwOG1NR2xNS3dHQmNkamE4Kno0MTV8cnM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}
Response headers

 cache-control: no-cache  content-language: en-US  content-length: 302  content-type: application/json
 date: Thu, 20 May 2021 07:37:51 GMT
 expires: Thu, 01 Jan 1970 00:00:00 GMT
 x-ca-affinity: 3526048407
 x-ca-requesttime: path=session; start=1621496271093; end=1621496271177; elapsed=84
 x-ca-transaction: C9dGh9jqhGsClMdsM2h8ysMlMMvqhj9hl4Mhh 

Thanks!
---------
Amol
---------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

Is it correct response?
After that, i am going for GET request, using all session cookies in params and xsrf- token in the header sesction.

Still i am getting

"message": "Authentication required."
Please check all screenshots

{"message":"Authentication required."}

Sorry, that was my misunderstanding!! :-) I have the same JSON response.

XSRF-Token is part of cookies. You have to get this value from session headers. How to do that depends on your implementation. If you are using swagger from https://<cognos_analytics_server>:<port>/api/api-docs you can check it directly in your browser.

1.In Chrome/Edge (on Chromium) use shortcut CTRL + SHIFT + I. Developer console will open.
2. In developer Console, go to network tab
3. On Swagger, execute PUT request to create session
4. In Developer Console, on network tab new Cookies tab should be available. Here you can see your XSRF-Token cookie and its value. 

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUp6M2d6VXlUeWplNEdkVXk3cTBiUEo1S2IwOG1NR2xNS3dHQmNkamE4Kno0MTV8cnM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}

Response headers

 cache-control: no-cache  content-language: en-US  content-length: 302  content-type: application/json
 date: Thu, 20 May 2021 07:37:51 GMT
 expires: Thu, 01 Jan 1970 00:00:00 GMT
 x-ca-affinity: 3526048407
 x-ca-requesttime: path=session; start=1621496271093; end=1621496271177; elapsed=84
 x-ca-transaction: C9dGh9jqhGsClMdsM2h8ysMlMMvqhj9hl4Mhh 

Thanks!
---------
Amol
---------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

Hi, 

Andrew is right. You have to reuse all cookies. I am not aware of this implementation, but for instance in Java (with using apache.HttpClient), my process was following:

1. I send PUT request to create a session. I stored all cookies into a cookie store. 
2. For other requests I manually adding X-XSRF-Token header with value from XSRF-Token cookie retrieved in step one, but I also reusing all cookies from step one because I initialized the cookie store in first step. 

I also suppose that XSRF-Token cookie value has to match with X-XSRF-Token header.

Is it correct response?
After that, i am going for GET request, using all session cookies in params and xsrf- token in the header sesction.

Still i am getting

"message": "Authentication required."
Please check all screenshots

{"message":"Authentication required."}

Sorry, that was my misunderstanding!! :-) I have the same JSON response.

XSRF-Token is part of cookies. You have to get this value from session headers. How to do that depends on your implementation. If you are using swagger from https://<cognos_analytics_server>:<port>/api/api-docs you can check it directly in your browser.

1.In Chrome/Edge (on Chromium) use shortcut CTRL + SHIFT + I. Developer console will open.
2. In developer Console, go to network tab
3. On Swagger, execute PUT request to create session
4. In Developer Console, on network tab new Cookies tab should be available. Here you can see your XSRF-Token cookie and its value. 

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUp6M2d6VXlUeWplNEdkVXk3cTBiUEo1S2IwOG1NR2xNS3dHQmNkamE4Kno0MTV8cnM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}
Response headers

 cache-control: no-cache  content-language: en-US  content-length: 302  content-type: application/json
 date: Thu, 20 May 2021 07:37:51 GMT
 expires: Thu, 01 Jan 1970 00:00:00 GMT
 x-ca-affinity: 3526048407
 x-ca-requesttime: path=session; start=1621496271093; end=1621496271177; elapsed=84
 x-ca-transaction: C9dGh9jqhGsClMdsM2h8ysMlMMvqhj9hl4Mhh 

Thanks!
---------
Amol
---------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

Hi, 

Andrew is right. You have to reuse all cookies. I am not aware of this implementation, but for instance in Java (with using apache.HttpClient), my process was following:

1. I send PUT request to create a session. I stored all cookies into a cookie store. 
2. For other requests I manually adding X-XSRF-Token header with value from XSRF-Token cookie retrieved in step one, but I also reusing all cookies from step one because I initialized the cookie store in first step. 

I also suppose that XSRF-Token cookie value has to match with X-XSRF-Token header.

Is it correct response?
After that, i am going for GET request, using all session cookies in params and xsrf- token in the header sesction.

Still i am getting

"message": "Authentication required."
Please check all screenshots

{"message":"Authentication required."}

Sorry, that was my misunderstanding!! :-) I have the same JSON response.

XSRF-Token is part of cookies. You have to get this value from session headers. How to do that depends on your implementation. If you are using swagger from https://<cognos_analytics_server>:<port>/api/api-docs you can check it directly in your browser.

1.In Chrome/Edge (on Chromium) use shortcut CTRL + SHIFT + I. Developer console will open.
2. In developer Console, go to network tab
3. On Swagger, execute PUT request to create session
4. In Developer Console, on network tab new Cookies tab should be available. Here you can see your XSRF-Token cookie and its value. 

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUp6M2d6VXlUeWplNEdkVXk3cTBiUEo1S2IwOG1NR2xNS3dHQmNkamE4Kno0MTV8cnM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}
Response headers

 cache-control: no-cache  content-language: en-US  content-length: 302  content-type: application/json
 date: Thu, 20 May 2021 07:37:51 GMT
 expires: Thu, 01 Jan 1970 00:00:00 GMT
 x-ca-affinity: 3526048407
 x-ca-requesttime: path=session; start=1621496271093; end=1621496271177; elapsed=84
 x-ca-transaction: C9dGh9jqhGsClMdsM2h8ysMlMMvqhj9hl4Mhh 

Thanks!
---------
Amol
---------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug

{"message":"Authentication required."}

Sorry, that was my misunderstanding!! :-) I have the same JSON response.

XSRF-Token is part of cookies. You have to get this value from session headers. How to do that depends on your implementation. If you are using swagger from https://<cognos_analytics_server>:<port>/api/api-docs you can check it directly in your browser.

1.In Chrome/Edge (on Chromium) use shortcut CTRL + SHIFT + I. Developer console will open.
2. In developer Console, go to network tab
3. On Swagger, execute PUT request to create session
4. In Developer Console, on network tab new Cookies tab should be available. Here you can see your XSRF-Token cookie and its value. 

{  "generation": 3,  "shareable": false,  "isAnonymous": false,  "cafContextId": "CAFW000000a0Q0FGQTYwMDAwMDAwMDlBaFFBQUFDZUxHLWhHdEVBZTZFUW5neEw0Qi1TU2g1aGtRY0FBQUJUU0VFdE1qVTJJQUFBQUp6M2d6VXlUeWplNEdkVXk3cTBiUEo1S2IwOG1NR2xNS3dHQmNkamE4Kno0MTV8cnM_",  "logEnabled": false,  "canCallLogon": false,  "url": "/api/v1"}
Response headers

 cache-control: no-cache  content-language: en-US  content-length: 302  content-type: application/json
 date: Thu, 20 May 2021 07:37:51 GMT
 expires: Thu, 01 Jan 1970 00:00:00 GMT
 x-ca-affinity: 3526048407
 x-ca-requesttime: path=session; start=1621496271093; end=1621496271177; elapsed=84
 x-ca-transaction: C9dGh9jqhGsClMdsM2h8ysMlMMvqhj9hl4Mhh 

Thanks!
---------
Amol
---------

Hello  Amol,

I suppose ibmcognos/bi/v1/disp is legacy portal URL. You should be able to access to the REST API through this URL.

https://<cognos_analytics_server>:<port>/api/api-docs

See the REST API documentation .
So, for instance, to create session you have to run PUT request on https://<cognos_analytics_server>:<port>/api/v1/session URL with following JSON body: 

{  "parameters": [    {      "name": "CAMNamespace",      "value": "LDAP"    },    {      "name": "CAMUsername",      "value": "johnsmith"    },    {      "name": "CAMPassword",      "value": "mypassword"    }  ]}

 As a response, you should get XSRF-Token key. 

I also think that since CA 11.2.0 there is a change in logon action - you should be able to use cafContextId value in IBM-BA-Authorization header instead of reusing whole cookies. But unfortunately I have not had a time to test new Cognos version yet. 

Hi Doug, 

when I worked with REST API I found out, that I have to pass whole cookies set which I received from PUT /api/v1/session. You also have to add new header X-XSRF-TOKEN with value of XSRF-TOKEN which you received from PUT statement.

Then the other requests to the CA REST API are working fine. When I used only X-XSRF-TOKEN itself (without reusing cookies set from put statement), then I received "Authorization Required." error message.

Now I am not able to get any of the get requests to work.  I have taken XSRF-Token cookie returned from the Session Put into the header of a GET request, say for /api/v1/files.  When I submit that, I get an "Authorization Required" response.  When I look at the network activity when using the Swagger API Test Page, I see that there is also a Cookie parameter in the header that seems to contain all of the Set-Cookie information returned in the Session PUT response header.  So is that also required?

Doug