Get encrypted federation data
Generate an invite that can be sent to user so that they can join the federation.
Generate an invite that can be sent to user so that they can join the federation.
Authorization
SymetryMLAuth HMAC-SHA256 signature-based authentication: requests are signed with
your secret key and sent with the Customer-ID, Sym-date,
Authorization, Content-MD5 and sym-version headers.
See SymetryML REST API Security
for the signature algorithm and a complete example.
In: header
Path Parameters
User/Customer identifier
Project identifier
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Base64-encoded encrypted content — an AES-encrypted Map, encrypted with the customer's SML secret key. Select an example below to see its decrypted equivalent. passwd is required — it is used to encrypt the response. fed_rest_host is required and must not contain a path segment other than /. aws_id (AWS account id) is optional and only applies to AWS-type federations. fed_req_token_valid_hours is optional (defaults to a server-side setting) and controls how long the one-time join token stays valid.
Response Body
application/json
application/json
curl -X POST "https://example.com/c1/fedml/nbra_prj_iris/getEncrypted" \ -H "Content-Type: application/json" \ -d 'bkUrp+i5uw70XzQ5F4mnJFh7CraEi8152ucGYnaPgpDFrDncUtjA/OmLhRJHyTPvZxLpus0lN/3HSRuQv7xWHg=='values.encryptedGroupInfo is base64-encoded content, encrypted with the request's passwd (not the customer's SML secret key). It decrypts to the federation's REST callback URL and a one-time join request token, which the invited peer submits back when it later joins via createJoin.
Decrypted equivalent of values.encryptedGroupInfo:
{ "fed_inception_utime":"1756408413524", "sync_sched":"m1", "fed_name":"fedadmin", "fed_enforce_hipaa_compliance":"false", "fed_use_smpc":"false", "fed_req_token":"FEDTOKENXXXXXXXXXX", "fed_secret_key":"XXXXXXXXXXXXXXXX", "fed_rest_url":"http://charm:8080/symetry/rest/c1/fedml/fedadmin/fedtokennats"}{ "statusCode": 200, "statusString": "OK", "values": { "encryptedGroupInfo": "ODjRV0y1ct/w1TYCLzwdR/9hgaoN7Dr9lx34PjAXm1N/g4sEnp0udW0UIqNeMqCd5R3uLIopdTlfQuAu96DxpJNunA12+Eo8lt+lkH+kkNE292TVSWjRXze9/wfzsPS4WRxwWYNjlaaCQBPhV1v+nLO3NV2tIGmWL3DLV9KQrUWAt0PUQz1bfVxeii8ODfJ8utTPaXML+EikSsUEOTxoekIAkYrkiB/5cFY52Zth9a7RJStR/XyCgxm4dT0AsZGD+/7tBXYBQRtgA+Elvew998MLuouoO8i+LDEBXTc1Sx7ukddTBDa5+1F35pklU1NOFQcaMuGWNK46ei47u7w/ak7lQ3w33j1sMRRuYvfk6J5KbZ24XCd4YgXUVNg1kbiZUh7btMP+/ijBj3QqAtvC/HJuJCwl/qoDjWNsK3bHNj8xp0ZMjblcXqQvoQKVokEODI4ZY/oirD68jbdiAoOP9psxBBITM4sGL4f1m5g/fDF8CESWYgfiuWivVWoWon/xd9duNo0/7KGpczwlJ60iI+0glCkJov9YdUAT1+eIHUGDfSSf4A8JK2x4L/UiTG+JeaREoqGa8UJElYR2c4HROn9oqCD48p1nAR9FSMtVHfA=" }}{ "statusCode": 500, "statusString": "Error Invalid project name / or not logged in.", "values": {}}