Back to All

PSP > Product Manager > Customer User Api Key

List Customer User Api Keys

get

Returns an array of customer user api keys for the request user. The response may vary based on the user's claims.

Claim-based access control: Super_Dev, Issuer_Admin, Issuer_Dev, Verifier_Admin, Verifier_Dev

Authorizations
Responses
200Success
application/json
get
/api/v1/psp/product-manager/customer-user-api-keys
GET /api/v1/psp/product-manager/customer-user-api-keys HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "keyMask": "text",
    "name": "text",
    "userCognitoSub": "123e4567-e89b-12d3-a456-426614174000",
    "creatorCognitoSub": "123e4567-e89b-12d3-a456-426614174000",
    "expiresAt": "2025-10-30T23:19:00.112Z",
    "createdAt": "2025-10-30T23:19:00.112Z",
    "status": "active",
    "organisationName": "text"
  }
]

Create Customer User Api Key

post

Create a new customer user api key for the request user in the given environment.

Claim-based access control: Issuer_Admin, Issuer_Dev, Verifier_Admin, Verifier_Dev

Authorizations
Body
namestring · min: 1 · max: 50Required
Responses
201Success
application/json
post
/api/v1/psp/product-manager/customer-user-api-keys
POST /api/v1/psp/product-manager/customer-user-api-keys HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "id": 1,
  "keyMask": "text",
  "name": "text",
  "userCognitoSub": "123e4567-e89b-12d3-a456-426614174000",
  "creatorCognitoSub": "123e4567-e89b-12d3-a456-426614174000",
  "expiresAt": "2025-10-30T23:19:00.112Z",
  "createdAt": "2025-10-30T23:19:00.112Z",
  "status": "active",
  "rawKey": "text"
}

Delete Customer User Api Key

delete

Deletes the specified customer user Api key

Claim-based access control: Super_Dev, Issuer_Admin, Issuer_Dev, Verifier_Admin, Verifier_Dev

Authorizations
Path parameters
apiKeyIdnumberRequired
Responses
204

Api key deleted successfully.

No content
delete
/api/v1/psp/product-manager/customer-user-api-keys/{apiKeyId}
DELETE /api/v1/psp/product-manager/customer-user-api-keys/{apiKeyId} HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update Customer User Api Key

patch

Updates the specified customer user Api key

Claim-based access control: Super_Dev, Issuer_Admin, Issuer_Dev, Verifier_Admin, Verifier_Dev

Authorizations
Path parameters
apiKeyIdnumberRequired
Body
statusall ofRequired
string · enumOptionalPossible values:
Responses
200Success
application/json
patch
/api/v1/psp/product-manager/customer-user-api-keys/{apiKeyId}
PATCH /api/v1/psp/product-manager/customer-user-api-keys/{apiKeyId} HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "status": "active"
}
{
  "id": 1,
  "keyMask": "text",
  "name": "text",
  "userCognitoSub": "123e4567-e89b-12d3-a456-426614174000",
  "creatorCognitoSub": "123e4567-e89b-12d3-a456-426614174000",
  "expiresAt": "2025-10-30T23:19:00.112Z",
  "createdAt": "2025-10-30T23:19:00.112Z",
  "status": "active"
}

Get Customer User API Key usage for environment

get

Returns the current number of Customer User API Keys created in the specified environment and the maximum allowed based on environment limitations.

Claim-based access control: Super_Dev, Issuer_Admin, Issuer_Dev, Verifier_Admin, Verifier_Dev

Authorizations
Responses
200Success
application/json
get
/api/v1/psp/product-manager/customer-user-api-keys/usage
GET /api/v1/psp/product-manager/customer-user-api-keys/usage HTTP/1.1
Host: {PORTAL_API_BASE_URL}
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "used": 1,
  "limit": 1
}
PreviousNotificationsNextPSP > Product Manager > User Manager