Back to All

PSP > Product Manager > User Manager

List all customer users.

get

Returns a list of all customer users this request user has in this environment.

Claim-based access control: Issuer_Admin, Issuer_Auditor, Issuer_User, Verifier_Admin, Verifier_Auditor, Verifier_User

Authorizations
Query parameters
identityServiceNamestring · enumRequiredPossible values:
includeProfileImagebooleanOptional

Option to include the customer user's profile image from the user profile, if it exists.

Default: false
Responses
200Success
application/json
get
GET /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/user-manager/customer-users HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "email": "text",
    "status": "active",
    "roles": [
      {
        "name": "Issuer_Admin",
        "claims": [
          {
            "name": "text"
          }
        ]
      }
    ],
    "lastModifiedTimestamp": "2025-06-20T05:35:53.675Z",
    "profileImage": {
      "id": "text",
      "mimeType": "image/gif",
      "keyUrl": "text",
      "filename": "text"
    }
  }
]

Create new customer users.

post

Claim-based access control: Super_Dev, CreateUser, Issuer_Admin, Verifier_Admin

Authorizations
Body
Responses
201Success
application/json
post
POST /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/user-manager/customer-users/bulk HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "users": [
    {
      "name": "text",
      "email": "text",
      "issuerRole": "Issuer_Admin",
      "verifierRole": "Verifier_Admin"
    }
  ]
}
[
  {
    "user": {
      "id": "text",
      "name": "text",
      "email": "text",
      "status": "active",
      "roles": [
        {
          "name": "Issuer_Admin",
          "claims": [
            {
              "name": "text"
            }
          ]
        }
      ]
    },
    "email": "name@gmail.com",
    "status": "success",
    "error": "text"
  }
]

Update customer user.

patch

Enables an authenticated customer user to change their data.

Claim-based access control: Issuer_Admin, Verifier_Admin, Issuer_Auditor, Verifier_Auditor, Verifier_User, Issuer_User

Authorizations
Body
namestring · min: 1 · max: 200OptionalPattern: ^[\p{L}0-9\-_' ]+$
Responses
200Success
application/json
patch
PATCH /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/user-manager/customer-users/me HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
{
  "id": "text",
  "name": "text",
  "email": "text",
  "status": "active",
  "roles": [
    {
      "name": "Issuer_Admin",
      "claims": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Change customer user password.

patch

Enables an authenticated customer user to change their password.

Claim-based access control: Issuer_Admin, Issuer_Auditor, Issuer_User, Verifier_Admin, Verifier_Auditor, Verifier_User

Authorizations
Body
newPasswordstring · password · min: 10 · max: 99Required

Password, at least 10 characters, requires uppercase, number and special character

Pattern: ^(?=.{10,99}$)(?=.*[A-Z])(?=.*\d)(?=.*[\W_]).+$
Responses
200Success
application/json
patch
PATCH /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/user-manager/customer-users/me/password/change HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 26

{
  "newPassword": "password"
}
{
  "id": "text",
  "name": "text",
  "email": "text",
  "status": "active",
  "roles": [
    {
      "name": "Issuer_Admin",
      "claims": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Retrieve customer user.

get

Retrieves an existing customer user from the environment.

Claim-based access control: Issuer_Admin, Issuer_Auditor, Issuer_User, Verifier_Admin, Verifier_Auditor, Verifier_User

Authorizations
Path parameters
customerUserIdstringRequired
Responses
200Success
application/json
get
GET /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/user-manager/customer-users/{customerUserId} HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text",
  "email": "text",
  "status": "active",
  "roles": [
    {
      "name": "Issuer_Admin",
      "claims": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Update customer user.

patch

Updates an existing customer user from the environment.

Claim-based access control: Issuer_Admin, Verifier_Admin, Issuer_AddRole, Verifier_AddRole

Authorizations
Path parameters
customerUserIdstringRequired
Body
issuerRoleall ofOptional
string · enumOptionalPossible values:
verifierRoleall ofOptional
string · enumOptionalPossible values:
Responses
200Success
application/json
patch
PATCH /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/user-manager/customer-users/{customerUserId} HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 61

{
  "issuerRole": "Issuer_Admin",
  "verifierRole": "Verifier_Admin"
}
{
  "id": "text",
  "name": "text",
  "email": "text",
  "status": "active",
  "roles": [
    {
      "name": "Issuer_Admin",
      "claims": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

Disable customer user.

post

Disables and removes roles from an existing customer user from the environment.

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations
Path parameters
customerUserIdstringRequired
Responses
204
Customer user disabled successfully.
post
POST /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/user-manager/customer-users/{customerUserId}/disable HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Resend email invitation.

post

Send a new email invitation for a customer user that has not yet accepted it.

Claim-based access control: CreateUser, Issuer_Admin, Verifier_Admin

Authorizations
Path parameters
customerUserIdstringRequired
Responses
201Success
application/json
post
POST /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/user-manager/customer-users/{customerUserId}/resend-invitation HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "name": "text",
  "email": "text",
  "status": "active",
  "roles": [
    {
      "name": "Issuer_Admin",
      "claims": [
        {
          "name": "text"
        }
      ]
    }
  ]
}

List all Customer User Event.

get

Returns a list of all events for the provided customer user in this environment

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations
Path parameters
customerUserIdstringRequired
Responses
200Success
application/json
get
GET /products/web/$IDENTITY_ENV_ID/portalbackend/api/api/v1/psp/product-manager/user-manager/customer-users/{customerUserId}/events HTTP/1.1
Host: identity.nchainplatform.com
X-API-KEY: YOUR_API_KEY
Accept: */*

[
  {
    "id": "text",
    "role": "Issuer_Admin",
    "timestamp": "2025-06-20T05:35:53.675Z",
    "type": "user_added",
    "editor": {
      "id": "text",
      "name": "text",
      "email": "text",
      "status": "active"
    }
  }
]
PreviousPSP > Product Manager > Customer User Api KeyNextWhat is an issuer?