Update Vivox Config

PUT 
/v1/environment/:environment_id/vivox

Update vivox configuration for a specific environment

Request

Path Parameters

environment_id uuidrequired

The environment ID for this request

application/json

Body

required

enabled Enabled (boolean)required

If vivox configuration is enabled or not

server Server (string)required

Possible values: non-empty and <= 200 characters

Vivox server to request and validate tokens from

key_issuer Key Issuer (string)required

Possible values: non-empty and <= 200 characters

Issuer for vivox tokens

key_lifetime Key Lifetime (integer)required

Possible values: > 0

Lifetime of generated vivox tokens

signature_algorithm SigningAlgorithm (string)

Possible values: [HS256]

An enumeration.

signing_key Signing Key (string)

Possible values: non-empty

Key used to sign vivox tokens. Need elevated permissions to view

Responses

204

Successful Response

404

Not Found

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...