Update sandbox organisation

PUT 
/v2/config/sandbox-org/:sandboxOrgId

Updates the name and the description of one sandbox organisation. Give the sandbox organisation ID in the path.

The service changes only the fields that you send with a value that is not an empty string. To keep a field, leave it out. The new name must be unique in the organisation.

You cannot update the main wallet through this endpoint. If the given ID is the main wallet, the service gives HTTP 400. If the sandbox organisation is deployed, the service also sends the new name and the new description to its wallet.

Request

Path Parameters

sandboxOrgId stringrequired

Unique identifier of the sandbox organisation.

application/json

Body

required

The fields of the sandbox organisation to change.

sandboxOrg objectrequired

The fields of the sandbox organisation to change.

name string

New name of the sandbox organisation. The name must be unique in the organisation. If a different sandbox organisation has the same name, the service gives HTTP 400. An empty string keeps the current name.

description string

New description of the sandbox organisation. An empty string keeps the current description.

Responses

200

The service updated the sandbox organisation.

Response Headers

application/json

Schema

Schema

sandboxOrg objectrequired

The sandbox organisation after the update.

id stringrequired

Unique identifier of the sandbox organisation

name stringrequired

Display name of the sandbox organisation

description stringrequired

Human readable description of the sandbox organisation

openIdDeploymentId stringrequired

Identifier of the associated OpenID deployment

status integerrequired

Status code of the sandbox organisation

ledgerId integerrequired

Identifier of the associated ledger

infrastructureProvider stringrequired

Name of the infrastructure provider

version stringrequired

Version of the sandbox organisation configuration

role stringrequired

Role of the sandbox organisation in the ecosystem

trustAnchor stringrequired

Trust anchor identifier or DID

isWalletProvider booleanrequired

Indicates whether this sandbox organisation acts as a wallet provider

secureVault integerrequired

Identifier of the primary secure vault

secureVaults integer[]nullable

Identifiers of the secure vaults that the sandbox organisation uses. The field holds null when the sandbox organisation has no secure vault.

logoImageId string

Identifier of the logo image. The field is absent when the sandbox organisation has no logo image.

coverImageId string

Identifier of the cover image. The field is absent when the sandbox organisation has no cover image.

logoImageUrl stringrequired

Public URL for the logo image

coverImageUrl stringrequired

Public URL for the cover image

createdAt integerrequired

Timestamp when the sandbox organisation was created

updatedAt integerrequired

Timestamp when the sandbox organisation was last updated

isMain booleanrequired

Indicates whether this is the main organisation

Example (from schema)

{
  "sandboxOrg": {
    "id": "string",
    "name": "string",
    "description": "string",
    "openIdDeploymentId": "string",
    "status": 0,
    "ledgerId": 0,
    "infrastructureProvider": "string",
    "version": "string",
    "role": "string",
    "trustAnchor": "string",
    "isWalletProvider": true,
    "secureVault": 0,
    "secureVaults": [
      0
    ],
    "logoImageId": "string",
    "coverImageId": "string",
    "logoImageUrl": "string",
    "coverImageUrl": "string",
    "createdAt": 0,
    "updatedAt": 0,
    "isMain": true
  }
}

Example

{
  "sandboxOrg": {
    "id": "6889e1a4c5b2f30001a3d710",
    "name": "Acme Test Issuer",
    "description": "Sandbox organisation for issuance tests",
    "openIdDeploymentId": "6889e1a4c5b2f30001a3d711",
    "status": 2,
    "ledgerId": 0,
    "infrastructureProvider": "iGrant",
    "version": "1.0.0",
    "role": "",
    "trustAnchor": "",
    "isWalletProvider": false,
    "secureVault": 0,
    "secureVaults": null,
    "logoImageId": "6889e1a4c5b2f30001a3d6f0",
    "coverImageId": "6889e1a4c5b2f30001a3d6f1",
    "logoImageUrl": "https://demo-api.igrant.io/v2/onboard/image/6889e1a4c5b2f30001a3d6f0/web",
    "coverImageUrl": "https://demo-api.igrant.io/v2/onboard/image/6889e1a4c5b2f30001a3d6f1/web",
    "createdAt": 1754745764,
    "updatedAt": 1754748900,
    "isMain": false
  }
}

400

The given ID is the main wallet, a different sandbox organisation has the same name, or the service could not send the change to the wallet of the sandbox organisation.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

401

Unauthorized

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

404

The organisation has no sandbox organisation with this ID.

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

500

Internal server error

Response Headers

application/json

Schema

Schema

errorCode integerrequired
errorDescription stringrequired

Example (from schema)

{
  "errorCode": 400,
  "errorDescription": "Bad input parameter"
}

Loading...