v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

apikeys

create a new API key based on caller rights

post/api/servicesecurity/processes/apikey/generate

Request body

labelstring required

Example request

{
  "label": "Label for the API key"
}

Response

Create a new API key

Example response

{
  "data": {
    "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "key": "90e50e3491e6479080fcdd008223896f",
    "secret": "$2b$14$sXpy9QOx4pwG1axR2vTf3u14BDPDZHpy0sNnQpI.iQO2OsHHB.66G",
    "label": "My Key",
    "audience": "employer",
    "audienceUuid": "0e0bbc38-e8bd-4542-8f5f-bdb64b16a5d3",
    "companyUuid": "8ec5bccb-d94a-4ac5-8fc1-5e2bba84bac3",
    "userUuid": "7ba18bc7-885a-4dc7-a006-b1a0f54e1821",
    "lastAuthenticatedAt": "2021-03-24T17:26:45.275Z"
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}