Older version

Using PhenixID HTTP API for ticket translation oAuth2 Bearer token - SAML2 (eHM SAML Token use case)

Overview

To use the API, one method is called. It will return:

- HTTP Status code 200 if oAuth2 access_token is still valid. SAMLResponse (base64 encoded) will be returned

- HTTP Status code 403 if oAuth2 access_token is not valid.

Prerequisites

- PhenixID Authentication Services HTTP API configured for oAuth2-SAML2 ticket translation use case

ehmSamlToken - data to be fetched before api call

The api client must fetch this value:

- access_token, returned from previous authentication (this might be returned through API, OIDC or "ordinary" SAML2)

How this parameter is fetched may differ depending on the use case.

ehmSamlToken - api call

Request

Method: HTTP PUT

Endpoint: /api/authentication/ehmSAMLToken

Headers:

Name	Value	Mandatory	Comment
Content-Type	application/json	Yes
tenant	t1	Yes	.Value must be given to you by PhenixID Signing Service admin, it might differ depending on the environment.
Authorization	Bearer <access_token>	Yes	<access_token> should be replaced with the access_token fetched previously.

Body:

No body content.

Example request

PUT /api/authentication/ehmSAMLToken HTTP/1.1
Host: integration.phenixid.se
tenant: t1
Content-Type: application/json
Authorization: Bearer f4974cb0-837b-44ff-aa43-e70187ab0663
cache-control: no-cache

Response

Response

The HTTP Response status code may have one of these values:

1. 200. oAuth2 bearer token is valid. Body will contain SAMLResponse.

2. 403. oAuth2 bearer token is not valid - user must re-authenticate.

The response body JSON structure properties:

Name	Comment
SAMLResponse	The entire SAML Response, base64 encoded.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 390010
{
    "SAMLResponse": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz48c2FtbDJwOlJlc3BvbnNlIHhtbG5zOnNhbWwycD0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOnByb3RvY29sIiB4bWxuczp4cz0iaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEiIERlc3RpbmF0aW9uPSJodHRwczovL3d3dzYuYXBvdGVrZXQuc2UvYXV0aGVudGljYXRlL3ZhbGlkYXRlZWxlZ2xvZ2luIiBJRD0iX2YyY2NiOTMzNGYwZDZmMDhmNzUxYTY1YWI3MjVlMjZiIiBJc3N1ZUluc3RhbnQ9IjIwMTktMDMtMDZUMTM6NTE6MTBaIiBWZXJzaW9uPSIyLjAiPjxzYW1sMjpJc3N1ZXIgeG1sbnM6c2FtbDI9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDphc3NlcnRpb24iPmh0dHBzOi8vaW50ZWdyYXRpb24ucGhlbml4aWQuc2Uvc2FtbC9pZHAvcG9jPC9zYW1sMjpJc3N1ZXI+PGRzOlNpZ25hdHVyZSB4bWxuczpkcz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC8wOS94bWxkc2lnIyI+PGRzOlNpZ25lZEluZm8+PGRzOkNhbm9uaWNhbGl6YXRpb25NZXRob2QgQWxnb3JpdGhtPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxLzEwL3htbC1leGMtYzE0biMiLz48ZHM6U2lnbmF0dXJlTWV0aG9kIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMS8wNC94bWxkc2lnLW1vcmUjcnNhLXNoYTI1NiIvPjxkczpSZWZlcmVuY2UgVVJJPSIjX2YyY2NiOTMzNGYwZDZmMDhmNzUxYTY1YWI3MjVlMjZiIj48ZHM6VHJhbnNmb3Jtcz48ZHM6VHJhbnNmb3JtIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMC8wOS94bWxkc2lnI2VudmVsb3BlZC1zaWduYXR1cmUiLz48ZHM6VHJhbnNmb3JtIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMS8xMC94bWwtZXhjLWMxNG4jIj48ZWM6SW5jbHVzaXZlTmFtZXNwYWNlcyB4bWxuczplYz0iaHR0cDovL3d3dy53My5vcmcvMjAwMS8xMC94bWwtZXhjLWMxNG4jIiBQcmVmaXhMaXN0PSJ4cyIvPjwvZHM6VHJhbnNmb3JtPjwvZHM6VHJhbnNmb3Jtcz48ZHM6RGlnZXN0TWV0aG9kIEFsZ29yaXRobT0iaHR0cDovL3d3dy53My5vcmcvMjAwMC8wOS94bWxkc2lnI3NoYTEiLz48ZHM6RGlnZXN0VmFsdWU+bDJqR0p5d0l0RG9weHNDUHQ2L3VONUZMdnF3PTwvZHM6RGlnZXN0VmFsdWU+PC9kczpSZWZlcmVuY2U+PC9kczpTaWduZWRJbmZvPjxkczpTaWduYXR1cmVWYWx1ZT5qR1dUVVJLZk5HODJ1RnJsMlE4eFNGRHU2czc5aElLSXB1cXExRmJablhVRjlPak4wVG9aZ1JYNmVhSUJVb202WlFZL01uc0J4QjFoCkhKVmlhUEJvM2hmU2lpbi9LUmU5MWt4QzlVWDNONkUrYTlxQTJEcTRpZHdORkd0KzNHbytzU2VqQnJ0bkdyUmdVYkNlL2M0QkRnU2MKNnp5eFFKZVlkTStMWWcxdkp2UkpEeDdOaDBsbHZWTzN6L2R3ZU9PT3h0VWVqTVdIeStTM21yZEFIUjZoVS9YeGtFZDZZcWNMTGt4Ngo1VHpaMEFUWjh2RGt2dHgrbzlxQlpoWVJFRDQyYkZOWnFuRGU1c0RiOUFjZm9jV25XV0tKS3czZ1p6NTNKNUNYYmJQZEE2MERkSWhRCk9YdzBCTE1ndHludGRWN2hjcG8vWVJFZjF6MHVMZ2ROVWIyTHZ3PT08L2RzOlNpZ25hdHVyZVZhbHVlPjxkczpLZXlJbmZvPjxkczpYNTA5RGF0YT48ZHM6WDUwOUNlcnRpZmljYXRlPk1JSURZRENDQWtpZ0F3SUJBZ0lCRmpBTkJna3Foa2lHOXcwQkFRVUZBREJuTVFzd0NRWURWUVFHRXdKVFJURVZNQk1HQTFVRUJ4TU0KVG1GamEyRWdVM1J5WVc1a01ROHdEUVlEVlFRS0V3Wk5ZMEZtWldVeEZEQVNCZ05WQkFzVEMwVnVaMmx1WldWeWFXNW5NUm93R0FZRApWUVFERXhGRlFTQkVSVTFQSUhWelpYSWdRMEVnTVRBZUZ3MHhOREExTWpNeE1qQTNNREJhRncweE9UQTFNak14TWpBM01EQmFNRUl4CkRqQU1CZ05WQkFNVEJXSm9kV3hzTVEwd0N3WURWUVFFRXdSSWRXeHNNUTR3REFZRFZRUXFFd1ZDYjJKaWVURVJNQThHQTFVRUJSTUkKTVRrMk5URTVOall3Z2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRQzh5Vm93cW1wZmVLcHR1aWdxRkhqZQpLQy9DVmlBTWV4bmJnQ1lkYm85YXRJYzA4YjM1bFYzNjR1VHBrYWZ1cGdBZXhUaTlYMUdPdUtFTTRLS2dBUVE5MXNTUEpldXo3cjZZCjVFTjVITy9kRVh0dVFYYjFUd1oyRkd2REVFYWVGaWdReU5BTHhuVXJoV3lmd1NjZVUzZXY0aitRYkdwUnVYN01mWVQ2QlpibXJXeVYKMCtqL21JSHE5ZGZMY3A0OHdmVFBoNlZYbzFpSENZUVZ0bjNaRkhQN29GdGIveHlKaTYyZHZGcXJzbkViRmtmbVJOK3NSbWdmSnRDOQowampQdmJqTXNVSGFLbVloOTlGcksyNmUxTjJUOGN4WnNILzNYeDJocEUxakw5VG9sclYrWVE1WGRGZkpSSGVBb0cwelg3cnR0NzIyCmtNT0FKcStlTkJwUlhYZWpBZ01CQUFHalBEQTZNQXdHQTFVZEV3RUIvd1FDTUFBd0hRWURWUjBPQkJZRUZQT3lwRHVhdWZmWGt3ak4KZGVOdGkwSWtZU3BkTUFzR0ExVWREd1FFQXdJRXNEQU5CZ2txaGtpRzl3MEJBUVVGQUFPQ0FRRUFNQXhCOTVHL1hDT2V0d0FNMUtYdAo3cUgrdFUwbXZiWEhxZ1dkeUhSRkhlYXlRam1LcDM4MzFjaU5XRVlEU0J2R29VejJGSTBXUWpyQkVURFhrd29YUnhGZjgxbzhTU0ZrCkMySHBpdHFVVy9vbitsSDR2MnU3VTJ5YU81clVYd0ZzaVU2M05ySklQdHRqRHp5SmNIRlZYcTFKcm5SV0RZcThYMEphVGgzUlU5UHcKdzhlTjJkdzhNakhMRHRneFpnM3ZQRWxrU1dhRFRzZS9IZlFQQmMwY0FjMkQ3L0hPajNxeXJFcUlEckhIbVFCVGtDNVM5Qy9PMXNFaApwSmt0cWk4U01VbW1uaVZoaFI1djVNVk5QR2xJRHpRd0o5blhXemRCejV3bVFxTGt3Mi84NTNPdWpWSzJaWGNLQjZlOUdrbEhCdzVZCnRGSXRiTW1WdnV4Q241VGZjUT09PC9kczpYNTA5Q2VydGlmaWNhdGU+PC9kczpYNTA5RGF0YT48L2RzOktleUluZm8+PC9kczpTaWduYXR1cmU+PHNhbWwycDpTdGF0dXMgeG1sbnM6c2FtbDJwPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6cHJvdG9jb2wiPjxzYW1sMnA6U3RhdHVzQ29kZSBWYWx1ZT0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOnN0YXR1czpTdWNjZXNzIi8+PC9zYW1sMnA6U3RhdHVzPjxzYW1sMjpBc3NlcnRpb24geG1sbnM6c2FtbDI9InVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDphc3NlcnRpb24iIElEPSJfNTRjOTRjZjA4MjFiYWM4NDIwODIzNGJlNzZiYWU3MzQiIElzc3VlSW5zdGFudD0iMjAxOS0wMy0wNlQxMzo1MToxMFoiIFZlcnNpb249IjIuMCI+PHNhbWwyOklzc3Vlcj5odHRwczovL2ludGVncmF0aW9uLnBoZW5peGlkLnNlL3NhbWwvaWRwL3BvYzwvc2FtbDI6SXNzdWVyPjxzYW1sMjpTdWJqZWN0PjxzYW1sMjpOYW1lSUQgRm9ybWF0PSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoxLjE6bmFtZWlkLWZvcm1hdDp1bnNwZWNpZmllZCI+MTkxMjEyMTI3NzcxPC9zYW1sMjpOYW1lSUQ+PHNhbWwyOlN1YmplY3RDb25maXJtYXRpb24gTWV0aG9kPSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6Y206YmVhcmVyIj48c2FtbDI6U3ViamVjdENvbmZpcm1hdGlvbkRhdGEgTm90T25PckFmdGVyPSIyMDE5LTAzLTA2VDEzOjUzOjEwWiIgUmVjaXBpZW50PSJodHRwczovL3d3dzYuYXBvdGVrZXQuc2UvYXV0aGVudGljYXRlL3ZhbGlkYXRlZWxlZ2xvZ2luIi8+PC9zYW1sMjpTdWJqZWN0Q29uZmlybWF0aW9uPjwvc2FtbDI6U3ViamVjdD48c2FtbDI6Q29uZGl0aW9ucyBOb3RCZWZvcmU9IjIwMTktMDMtMDZUMTM6NTE6MTBaIiBOb3RPbk9yQWZ0ZXI9IjIwMTktMDMtMDZUMTM6NTM6MTBaIj48c2FtbDI6QXVkaWVuY2VSZXN0cmljdGlvbj48c2FtbDI6QXVkaWVuY2U+aHR0cHM6Ly93d3c2LmFwb3Rla2V0LnNlL2F1dGhlbnRpY2F0ZS92YWxpZGF0ZWVsZWdsb2dpbi1QUk9ELUZFRDwvc2FtbDI6QXVkaWVuY2U+PC9zYW1sMjpBdWRpZW5jZVJlc3RyaWN0aW9uPjwvc2FtbDI6Q29uZGl0aW9ucz48c2FtbDI6QXV0aG5TdGF0ZW1lbnQgQXV0aG5JbnN0YW50PSIyMDE5LTAzLTA2VDEzOjUxOjEwWiIgU2Vzc2lvbkluZGV4PSJmNDk3NGNiMC04MzdiLTQ0ZmYtYWE0My1lNzAxODdhYjA2NjMiPjxzYW1sMjpBdXRobkNvbnRleHQ+PHNhbWwyOkF1dGhuQ29udGV4dENsYXNzUmVmPnVybjpvYXNpczpuYW1lczp0YzpTQU1MOjIuMDphYzpjbGFzc2VzOlhNTERTaWc8L3NhbWwyOkF1dGhuQ29udGV4dENsYXNzUmVmPjwvc2FtbDI6QXV0aG5Db250ZXh0Pjwvc2FtbDI6QXV0aG5TdGF0ZW1lbnQ+PHNhbWwyOkF0dHJpYnV0ZVN0YXRlbWVudD48c2FtbDI6QXR0cmlidXRlIE5hbWU9Imh0dHA6Ly9zYW1iaS5zZS9hdHRyaWJ1dGVzLzEvZ2l2ZW5OYW1lIiBOYW1lRm9ybWF0PSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6YXR0cm5hbWUtZm9ybWF0OnVyaSI+PHNhbWwyOkF0dHJpYnV0ZVZhbHVlIHhtbG5zOnhzaT0iaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEtaW5zdGFuY2UiIHhtbG5zOnhzPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSIgeHNpOnR5cGU9InhzOnN0cmluZyI+UGVra2E8L3NhbWwyOkF0dHJpYnV0ZVZhbHVlPjwvc2FtbDI6QXR0cmlidXRlPjxzYW1sMjpBdHRyaWJ1dGUgTmFtZT0iaHR0cDovL3NhbWJpLnNlL2F0dHJpYnV0ZXMvMS9zdXJuYW1lIiBOYW1lRm9ybWF0PSJ1cm46b2FzaXM6bmFtZXM6dGM6U0FNTDoyLjA6YXR0cm5hbWUtZm9ybWF0OnVyaSI+PHNhbWwyOkF0dHJpYnV0ZVZhbHVlIHhtbG5zOnhzaT0iaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEtaW5zdGFuY2UiIHhtbG5zOnhzPSJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSIgeHNpOnR5cGU9InhzOnN0cmluZyI+TGFuZ2VyPC9zYW1sMjpBdHRyaWJ1dGVWYWx1ZT48L3NhbWwyOkF0dHJpYnV0ZT48c2FtbDI6QXR0cmlidXRlIE5hbWU9Imh0dHA6Ly9zYW1iaS5zZS9hdHRyaWJ1dGVzLzEvcGVyc29uYWxJZGVudGl0eU51bWJlciIgTmFtZUZvcm1hdD0idXJuOm9hc2lzOm5hbWVzOnRjOlNBTUw6Mi4wOmF0dHJuYW1lLWZvcm1hdDp1cmkiPjxzYW1sMjpBdHRyaWJ1dGVWYWx1ZSB4bWxuczp4c2k9Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hLWluc3RhbmNlIiB4bWxuczp4cz0iaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEiIHhzaTp0eXBlPSJ4czpzdHJpbmciPjE5MTIxMjEyNzc3MTwvc2FtbDI6QXR0cmlidXRlVmFsdWU+PC9zYW1sMjpBdHRyaWJ1dGU+PC9zYW1sMjpBdHRyaWJ1dGVTdGF0ZW1lbnQ+PC9zYW1sMjpBc3NlcnRpb24+PC9zYW1sMnA6UmVzcG9uc2U+"
}