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

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

503

PSP Product Manager Api is unavailable.

get

GET /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/customer-user-api-keys HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "keyMask": "text",
    "name": "text",
    "userCognitoSub": "123e4567-e89b-12d3-a456-426614174000",
    "creatorCognitoSub": "123e4567-e89b-12d3-a456-426614174000",
    "expiresAt": "2025-07-07T15:16:45.936Z",
    "createdAt": "2025-07-07T15:16:45.936Z",
    "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

400

Invalid request body.

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

503

PSP Product Manager Api is unavailable.

post

POST /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/customer-user-api-keys HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
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-07-07T15:16:45.936Z",
  "createdAt": "2025-07-07T15:16:45.936Z",
  "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.

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

404

Api key not found.

503

PSP Product Manager Api is unavailable.

delete

DELETE /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/customer-user-api-keys/{apiKeyId} HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
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

400

Invalid request body.

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

404

Api key not found.

503

PSP Product Manager Api is unavailable.

patch

PATCH /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/customer-user-api-keys/{apiKeyId} HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
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-07-07T15:16:45.936Z",
  "createdAt": "2025-07-07T15:16:45.936Z",
  "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

401

Invalid authentication credentials.

403

User does not have a required claim to perform this operation.

503

PSP Product Manager Api is unavailable.

get

GET /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/customer-user-api-keys/usage HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "used": 1,
  "limit": 1
}