DIdigicert
accessmanagement - api keys

Lists all available API keys.

This endpoint lists all available API keys, providing users with full visibility into the keys associated with their account.</br></br>Key features include:</br></br>- Clear success messaging: Returns a 200 success code with a confirmation message indicating the successful completion of the requested action.</br>- Controlled data limits: The pageSize parameter allows users to define the maximum number of API keys to display per page, optimizing data retrieval for specific use cases.</br>- Customizable pagination: The pageNumber parameter allows users to specify the page of results they wish to retrieve, ensuring targeted access to data.</br>- Efficient sorting: The sortBy parameter enables users to organize responses by various attributes, offering flexibility in result management.</br>- Targeted data retrieval: Employs the userId parameter to return the specified user's API keys, ensuring accuracy and relevance in the response

get/accessmanagement/api-key

Request

Query parameters

pageSizeinteger

The maximum number of API keys to return per page. Defaults to 25 if not specified.

pageNumberinteger

The page of results to return. Defaults to 0 if not specified.

userIdinteger

Filters data by the user's unique identifier.

sortBy'createdTsAsc' | 'createdTsDesc' | 'modifiedTsAsc' | 'modifiedTsDesc' | 'lastUsedTsAsc' | 'lastUsedTsDesc' | 'expirationDateAsc' | 'expirationDateDesc' | 'nameAsc' | 'nameDesc'

Specifies the sorting order of results.

type'service' | 'user'

Filters data by the API key type.

Response

API keys listed successfully.

totalinteger
countinteger
perPageinteger
currentPageinteger
totalPagesinteger

Example response

{
  "data": [
    {
      "id": "7e58d63b60197ceb55a1c487989a3720",
      "name": "Test Key",
      "username": "username@user.com",
      "userId": "1234",
      "keySuffix": "EcuGg",
      "expirationDate": "2026-12-15T12:11:33Z",
      "note": "None",
      "status": "ACTIVE",
      "lastUsedTs": "2025-09-10T15:06:24.154618Z",
      "createdTs": "2025-09-10T15:06:24.154618Z",
      "modifiedTs": "2025-09-10T15:06:24.154618Z",
      "roles": [
        {
          "id": 3,
          "name": "Admin",
          "description": "Administrator role with full permissions"
        }
      ],
      "resourceGroups": [
        {
          "id": 2,
          "name": "Default",
          "description": "Default resource group",
          "isDefault": true
        }
      ],
      "userGroups": [
        {
          "id": 2,
          "name": "Default",
          "description": "Default group",
          "isDefault": true
        }
      ]
    }
  ],
  "total": 25,
  "count": 10,
  "perPage": 10,
  "totalPages": 3
}

Changes

No recorded changes to this operation across all 1 revision of this API.