Organisation Profiles

List organisation profiles for the request user's environment.

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200Success

application/json

idstringRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

createdBystring · uuidRequired

UUID of the user that created the record

updatedBystring · uuidOptional

UUID of the user that updated the record

namestring · min: 1 · max: 64Required

isDefaultbooleanRequired

pspEnvironmentIdstringRequired

401

Invalid authentication credentials.

403

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

get

/api/v1/organisation-profiles/me

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

{
  "id": "text",
  "createdAt": "2026-03-24T17:20:55.247Z",
  "updatedAt": "2026-03-24T17:20:55.247Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Create an organisation profile.

post

If its a first organisation profile, it is set as default.Accepts the next image formats: image/jpeg, image/png, image/gif, image/webp. Max size is: 2097152 bytes.

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

namestring · min: 1 · max: 64Required

imagestring · binaryOptional

Responses

201Success

application/json

400

Invalid request body.

401

Invalid authentication credentials.

403

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

409

Maximum number of organisation profiles reached. Current limit: 1

post

/api/v1/organisation-profiles

POST /products/web/12345/portal/backend/api/v1/organisation-profiles HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 32

{
  "name": "text",
  "image": "binary"
}

{
  "id": "text",
  "createdAt": "2026-03-24T17:20:55.247Z",
  "updatedAt": "2026-03-24T17:20:55.247Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Retrieve an organisation profile by id.

get

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

idstringRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

createdBystring · uuidRequired

UUID of the user that created the record

updatedBystring · uuidOptional

UUID of the user that updated the record

namestring · min: 1 · max: 64Required

isDefaultbooleanRequired

pspEnvironmentIdstringRequired

401

Invalid authentication credentials.

403

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

404

Organisation profile not found.

get

/api/v1/organisation-profiles/{id}

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

{
  "id": "text",
  "createdAt": "2026-03-24T17:20:55.247Z",
  "updatedAt": "2026-03-24T17:20:55.247Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Delete an organisation profile by id.

delete

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

204Success

401

Invalid authentication credentials.

403

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

404

Organisation profile not found.

delete

/api/v1/organisation-profiles/{id}

DELETE /products/web/12345/portal/backend/api/v1/organisation-profiles/{id} HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Updates an organisation profile that belongs to the user's environment with provided data.

patch

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

namestring · min: 1 · max: 64Optional

Responses

200Success

application/json

idstringRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

createdBystring · uuidRequired

UUID of the user that created the record

updatedBystring · uuidOptional

UUID of the user that updated the record

namestring · min: 1 · max: 64Required

isDefaultbooleanRequired

pspEnvironmentIdstringRequired

400

Invalid request body.

401

Invalid authentication credentials.

403

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

404

Organisation profile not found.

patch

/api/v1/organisation-profiles/{id}

PATCH /products/web/12345/portal/backend/api/v1/organisation-profiles/{id} HTTP/1.1
Host: identity.products.teranode.group
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

{
  "id": "text",
  "createdAt": "2026-03-24T17:20:55.247Z",
  "updatedAt": "2026-03-24T17:20:55.247Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Delete an image on the user's environment organisation profile.

delete

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Responses

200Success

application/json

idstringRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

createdBystring · uuidRequired

UUID of the user that created the record

updatedBystring · uuidOptional

UUID of the user that updated the record

namestring · min: 1 · max: 64Required

isDefaultbooleanRequired

pspEnvironmentIdstringRequired

400

Invalid request parameters.

401

Invalid authentication credentials.

403

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

404

Organisation profile not found.

delete

/api/v1/organisation-profiles/{id}/image

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

{
  "id": "text",
  "createdAt": "2026-03-24T17:20:55.247Z",
  "updatedAt": "2026-03-24T17:20:55.247Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

Update an image on the user's environment organisation profile.

patch

Claim-based access control: Issuer_Admin, Verifier_Admin

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

imagestring · binaryRequired

Responses

200Success

application/json

idstringRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

createdBystring · uuidRequired

UUID of the user that created the record

updatedBystring · uuidOptional

UUID of the user that updated the record

namestring · min: 1 · max: 64Required

isDefaultbooleanRequired

pspEnvironmentIdstringRequired

400

Invalid request body.

401

Invalid authentication credentials.

403

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

404

Organisation profile not found.

patch

/api/v1/organisation-profiles/{id}/image

PATCH /products/web/12345/portal/backend/api/v1/organisation-profiles/{id}/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-24T17:20:55.247Z",
  "updatedAt": "2026-03-24T17:20:55.247Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedByUser": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "John Doe",
    "userCognitoSub": "a1c41abf-516d-4b1d-8c37-3c4e36248c10",
    "identityProvider": "cognito"
  },
  "name": "text",
  "isDefault": true,
  "pspEnvironmentId": "text",
  "image": {
    "id": "text",
    "mimeType": "image/gif",
    "keyUrl": "text",
    "filename": "text"
  }
}

PreviousAuth NextUser Profiles

Last updated 3 months ago

hashtagList organisation profiles for the request user's environment.

hashtagCreate an organisation profile.

hashtagRetrieve an organisation profile by id.

hashtagDelete an organisation profile by id.

hashtagUpdates an organisation profile that belongs to the user's environment with provided data.

hashtagDelete an image on the user's environment organisation profile.

hashtagUpdate an image on the user's environment organisation profile.

List organisation profiles for the request user's environment.

Create an organisation profile.

Retrieve an organisation profile by id.

Delete an organisation profile by id.

Updates an organisation profile that belongs to the user's environment with provided data.

Delete an image on the user's environment organisation profile.

Update an image on the user's environment organisation profile.