List Client Applications

get/api/accounts/{accountId}/client-applications

Retrieves the client applications for the given account.

Request

Path Parameters

accountIdstringrequired
Id of the account to retrieve client applications for.

Response

Successful operation.

Body application/json

itemsobject[]
Items
- idstring
  The client application id.
- accountIdstring
  The partner account id that is affiliated with the client application.
- allowedOriginsstring[]
  The allowed origins for the client application.
- createdAtstring
  Timestamp of client application creation.
- modifiedAtstring
  Timestamp of modification.

Request parameters are invalid.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

Subject is not allowed to perform the action with the reason stated in the errorCode.

FORBIDDEN Resource does not exist or there are no sufficient permissions to perform the action.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/accounts/{accountId}/client-applications' \
  --header 'Authorization: Bearer <access-token>'

curl 'https://api.immersve.com/api/accounts/{accountId}/client-applications' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

curl 'https://test.immersve.com/api/accounts/{accountId}/client-applications' \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>'

Example Response

{
  "items": [
    {
      "id": "65a7e8ef0d230d0a6bf755e07d39eb02",
      "accountId": "225d85e65495722bf6517ea0ba0d6f56",
      "allowedOrigins": [
        [
          "https://develop-app.com",
          "http://localhost:3000"
        ]
      ],
      "createdAt": "2022-11-16T03:13:18.142Z",
      "modifiedAt": "2022-11-16T03:13:18.142Z"
    }
  ]
}

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}