User Profiles

Get the profile of the request user.

get

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

Authorizations

COGNITO_JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

idstringRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

userCognitoSubstringRequired

isFirstVisitbooleanRequired

namestringOptional

emailstringRequired

identityProviderstring · enumRequired

The identity provider used to authenticate the user.

Possible values:

401

Invalid authentication credentials.

403

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

get

/api/v1/user-profiles/me

HTTPcURLJavaScriptPython

GET /products/web/12345/portal/backend/api/v1/user-profiles/me HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "createdAt": "2026-03-25T01:09:47.700Z",
  "updatedAt": "2026-03-25T01:09:47.700Z",
  "userCognitoSub": "text",
  "isFirstVisit": true,
  "name": "text",
  "email": "text",
  "identityProvider": "cognito",
  "profileImage": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Update the profile of the request user.

patch

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

Authorizations

COGNITO_JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

isFirstVisitbooleanOptional

Responses

200Success

application/json

idstringRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

userCognitoSubstringRequired

isFirstVisitbooleanRequired

namestringOptional

emailstringRequired

identityProviderstring · enumRequired

The identity provider used to authenticate the user.

Possible values:

401

Invalid authentication credentials.

403

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

patch

/api/v1/user-profiles/me

HTTPcURLJavaScriptPython

PATCH /products/web/12345/portal/backend/api/v1/user-profiles/me HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "isFirstVisit": true
}

{
  "id": "text",
  "createdAt": "2026-03-25T01:09:47.700Z",
  "updatedAt": "2026-03-25T01:09:47.700Z",
  "userCognitoSub": "text",
  "isFirstVisit": true,
  "name": "text",
  "email": "text",
  "identityProvider": "cognito",
  "profileImage": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Delete the profile image of the request user.

delete

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

Authorizations

COGNITO_JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

idstringRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

userCognitoSubstringRequired

isFirstVisitbooleanRequired

namestringOptional

emailstringRequired

identityProviderstring · enumRequired

The identity provider used to authenticate the user.

Possible values:

400

Invalid request parameters.

401

Invalid authentication credentials.

403

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

404

User profile not found.

delete

/api/v1/user-profiles/me/image

HTTPcURLJavaScriptPython

DELETE /products/web/12345/portal/backend/api/v1/user-profiles/me/image HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "createdAt": "2026-03-25T01:09:47.700Z",
  "updatedAt": "2026-03-25T01:09:47.700Z",
  "userCognitoSub": "text",
  "isFirstVisit": true,
  "name": "text",
  "email": "text",
  "identityProvider": "cognito",
  "profileImage": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Upload a profile image for the request user.

patch

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

Authorizations

COGNITO_JWT

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

multipart/form-data

imagestring · binaryRequired

Responses

201Success

application/json

400

Invalid request body.

401

Invalid authentication credentials.

403

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

404

User profile not found.

413

Image exceeds the allowed size.

415

Unsupported media type.

patch

/api/v1/user-profiles/me/image

HTTPcURLJavaScriptPython

PATCH /products/web/12345/portal/backend/api/v1/user-profiles/me/image HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 18

{
  "image": "binary"
}

{
  "id": "text",
  "createdAt": "2026-03-25T01:09:47.700Z",
  "updatedAt": "2026-03-25T01:09:47.700Z",
  "userCognitoSub": "text",
  "isFirstVisit": true,
  "name": "text",
  "email": "text",
  "identityProvider": "cognito",
  "profileImage": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}