MEmetacopier
Account API

Get all API keys for an account

Changed on
get/rest/api/v1/accounts/{accountId}/apiKeys

Request

Path parameters

accountIdstring uuid required

Response

OK

accountIdstring uuid

You have to set it during resource creation, after that, it is only read-only

aliasstring
expiresAtstring date-time

Point in time after which this key is rejected. Null means the key never expires.

idinteger
keystring
keyType'INTEGRATION' | 'AI'

Key type: INTEGRATION or AI. At most one AI key per project; setting it on a second key clears the flag on the first. AI keys fail closed without an access policy and cannot be turned back into INTEGRATION keys.

lastUsedAtstring date-time

Last time this key was accepted on a request. Updated at most once per minute.

permissionType'READ_WRITE' | 'READ_ONLY'

Permission type: READ_WRITE or READ_ONLY

projectIdstring uuid

You have to set it during resource creation, after that, it is only read-only

revokedAtstring date-time

Point in time at which this key was revoked. Null means the key is active.

Example response

[
  {
    "accessPolicy": {
      "enabled": true,
      "endpointPolicyMode": "ALLOW_LIST",
      "endpoints": [
        {
          "method": "GET",
          "path": "/rest/api/v1/projects/{projectId}/strategies"
        }
      ],
      "fieldPolicyMode": "DENY_LIST",
      "fields": [
        {
          "dtoClassName": "AccountInformationDTO",
          "fieldName": "balance",
          "fieldType": "java.math.BigDecimal"
        }
      ]
    }
  }
]

Changes

  • 69d2d39c695eRevision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • 5c1371d2c0b2Revision changes
    • info

      endpoint added