POST User Api Key

Overview

---

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

POST User Api Key
Method	POST
URL or Endpoint	/api/organizations/organizationId/api-keys
Headers	Authorization
Parameters	organizationId, api-version
Body	Check request body below

The description of the URL parameter is as follows:

URL Parameter Name	Mandatory	Type	Description
organizationId	Yes	string	Unique Id of the organization.
api-version	No	string	The correct api version to use.

Request Body

{
  "listProjectsId": [
    "string"
  ],
  "roleId": 0,
  "userApiKey": {
    "apiName": "string",
    "hasExpireTime": true,
    "startDateTime": "2022-08-24T12:07:50.071Z",
    "expireDateTime": "2022-08-24T12:07:50.071Z"
  }
}

Field Name	Type	Description
listProjectsId	Array[String]	Represents the IDs of the projects.
roleId	integer($int32)	The ID of the role.
userApiKey	Object	The user Api Key object.
apiName	string	The name of the Api Key.
hasExpireTime	bool	Indicates whether the api key has an expiry date.
startDateTime	string	The starting date of the api key.
expireDateTime	string	The expiry date of the Api Key

Response

{
  "success": true,
  "errors": [
    "string"
  ],
  "messages": [
    "string"
  ],
  "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 Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
id	integer($int32)	The id of the ApiKey.
name	string	The name of the Api Key.
apiKey	string	The ApiKey.
startDate	Date	The starting date
expireDate	Date	The expiring date.
hasExpireTime	bool	Indicates whether the ApiKey can expire.
roleId	integer($int32)	The ID of the role.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

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

Errors

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