Skip to main content

POST User Api Key


The following table contains important information about the POST method in regards to adding a user Api Key.

POST User Api Key
URL or Endpoint/api/organizations/organizationId/api-keys
ParametersorganizationId, api-version
BodyCheck request body below

The description of the URL parameter is as follows:

URL Parameter NameMandatoryTypeDescription
organizationIdYesstringUnique Id of the organization.
api-versionNostringThe correct api version to use.

Request Body

"listProjectsId": [
"roleId": 0,
"userApiKey": {
"apiName": "string",
"hasExpireTime": true,
"startDateTime": "2022-08-24T12:07:50.071Z",
"expireDateTime": "2022-08-24T12:07:50.071Z"
Field NameTypeDescription
listProjectsIdArray[String]Represents the IDs of the projects.
roleIdinteger($int32)The ID of the role.
userApiKeyObjectThe user Api Key object.
apiNamestringThe name of the Api Key.
hasExpireTimeboolIndicates whether the api key has an expiry date.
startDateTimestringThe starting date of the api key.
expireDateTimestringThe expiry date of the Api Key


"success": true,
"errors": [
"messages": [
"result": {
"id": 0,
"name": "string",
"apiKey": "string",
"startDate": "2022-08-24T12:28:46.443Z",
"expireDate": "2022-08-24T12:28:46.443Z",
"hasExpireTime": true,
"roleId": 0
"resultInfo": "string",
"statusCode": 0

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the ApiKey.
namestringThe name of the Api Key.
apiKeystringThe ApiKey.
startDateDateThe starting date
expireDateDateThe expiring date.
hasExpireTimeboolIndicates whether the ApiKey can expire.
roleIdinteger($int32)The ID of the role.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.


For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed