Skip to content

Get Vivox Config

GET
/v1/environment/{environment_id}/vivox

Get the vivox configuration for a specific environment

Authorizations

Parameters

Path Parameters

environment_id
required

The environment ID for this request

string format: uuid

The environment ID for this request

Responses

200

Successful Response

Any of:
object
enabled
required

If vivox configuration is enabled or not

boolean
server
required

Vivox server to request and validate tokens from

string
>= 1 characters <= 200 characters
key_issuer
required

Issuer for vivox tokens

string
>= 1 characters <= 200 characters
key_lifetime
required

Lifetime of generated vivox tokens

integer
> 0
signature_algorithm

Algorithm used to sign vivox tokens

string
Allowed values: HS256
signing_key

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

string
>= 1 characters

404

Not Found

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string