Skip to main content

GET ApiKeys of Organization

Overview


The following table contains important information about the GET method in regards to receiving the ApiKeys of the organization.

GET ApiKeys of Organization
MethodGET
URL or Endpoint​/api​/organizations​/organizationId​/api-keys
HeadersAuthorization
ParametersorganizationId, api-version
BodyNot Applicable

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

The request does not contain a request body

Response

{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": [
{
"apiKeyId": 0,
"apiKeyName": "string",
"apiKey": "string",
"startDate": "2022-08-26T08:52:18.370Z",
"expireDate": "2022-08-26T08:52:18.370Z",
"hasExpireTime": true,
"projectsNameList": [
null
]
}
],
"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.
ApiKeyIdinteger($int32)The id of the ApiKey.
ApiKeyNamestringThe name of the Api Key.
apiKeystringThe ApiKey.
startDateDateThe starting date
expireDateDateThe expiring date.
hasExpireTimeboolIndicates whether the ApiKey can expire.
projectsNameListarray[]Array that returns a collection of projects name list.
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.

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