PUT
/
organisations
/
{organisationId}
/
apps
/
{appId}
cURL
curl --request PUT \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/apps/{appId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "<string>",
  "orgId": "<string>",
  "name": "<string>",
  "public": true,
  "server": {
    "name": "<string>",
    "url": "<string>"
  },
  "schemaMetadata": {
    "type": "<string>",
    "version": "<string>",
    "url": "<string>"
  },
  "supportedAuthConfigs": [
    {
      "type": "<string>",
      "isValid": true,
      "data": {
        "discoveryUrl": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>",
        "scopes": {}
      }
    }
  ],
  "imageUrl": "<string>",
  "schema": {
    "id": "<string>",
    "type": "<string>",
    "version": "<string>",
    "sourceUrl": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "schemaId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}'
{
  "id": "<string>",
  "orgId": "<string>",
  "name": "<string>",
  "public": true,
  "server": {
    "name": "<string>",
    "url": "<string>"
  },
  "schemaMetadata": {
    "type": "<string>",
    "version": "<string>",
    "url": "<string>"
  },
  "supportedAuthConfigs": [
    {
      "type": "<string>",
      "isValid": true,
      "data": {
        "discoveryUrl": "<string>",
        "clientId": "<string>",
        "clientSecret": "<string>",
        "scopes": {}
      }
    }
  ],
  "imageUrl": "<string>",
  "schema": {
    "id": "<string>",
    "type": "<string>",
    "version": "<string>",
    "sourceUrl": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z"
  },
  "schemaId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organisationId
string
required
​
appId
string
required

Body

application/json

Payload to update an existing App.

The id and orgId fields are immutable and must match the fields from the URL. This is a full replace/update, any unset fields will be unset in the database, for partial updates see the PATCH method.

​
id
string
required
​
orgId
string
required
​
name
string
required
​
public
boolean
required
​
server
object
required
​
schemaMetadata
object
required
​
schema
object
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
supportedAuthConfigs
object[]

SupportedAuthConfigs is a list of authentication standards which can be used to connect a user's account to this app. At least one auth type needs to be valid for the App to be used by a user.

​
imageUrl
string
​
schemaId
string
​
deletedAt
string<date-time>

Response

A single App result

​
id
string
required
​
orgId
string
required
​
name
string
required
​
public
boolean
required
​
server
object
required
​
schemaMetadata
object
required
​
schema
object
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
supportedAuthConfigs
object[]

SupportedAuthConfigs is a list of authentication standards which can be used to connect a user's account to this app. At least one auth type needs to be valid for the App to be used by a user.

​
imageUrl
string
​
schemaId
string
​
deletedAt
string<date-time>