Auvious Auth Server API v2.1.6

Auvious Auth Server provides the core security related services.

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

Authentication

HTTP Authentication, scheme: bearer
OAuth 2.0 Authorization.
- Flow: clientCredentials
- OAuth 2.0 Token URL = /oauth/token
- OAuth 2.0 Scope
  
  Scope Scope Description

Tickets

Get a ticket.

GET https://auvious.video/api/ticket/{ticketId} HTTP/1.1
Host: auvious.video
Accept: */*

Get a ticket. Regular access tickets return the persisted ticket response. Appointments manage tickets return the same response shape with properties filtered to properties.appointment_id and properties.application_id. Lifecycle timestamp fields include disabled, revoked, and rotated; expired remains a derived boolean.

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Ticket

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X GET https://auvious.video/api/ticket/{ticketId} \
  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "https://auvious.video/api/ticket/{ticketId}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/api/ticket/{ticketId}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/api/ticket/{ticketId}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video/api/ticket/{ticketId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://auvious.video/api/ticket/{ticketId}',
  params: {}, headers: headers

p JSON.parse(result)

Update a ticket

PUT https://auvious.video/api/ticket/{ticketId} HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Update a ticket with new properties. The ticket will be modified according to the provided properties.

Request body

{
  "organizationId": "string",
  "properties": {
    "property1": {},
    "property2": {}
  }
}

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	none
body	body	UpdateTicketWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Ticket

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X PUT https://auvious.video/api/ticket/{ticketId} \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("PUT", "https://auvious.video/api/ticket/{ticketId}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "organizationId": "string",
  "properties": {
    "property1": {},
    "property2": {}
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/api/ticket/{ticketId}', {
  method: 'PUT',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/api/ticket/{ticketId}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put(
  'https://auvious.video/api/ticket/{ticketId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://auvious.video/api/ticket/{ticketId}',
  params: {}, headers: headers

p JSON.parse(result)

Delete a ticket.

DELETE https://auvious.video/api/ticket/{ticketId} HTTP/1.1
Host: auvious.video

Delete a ticket. Optional operation, use it to delete a token early, before it's used or expired

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	None

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X DELETE https://auvious.video/api/ticket/{ticketId} \
  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("DELETE", "https://auvious.video/api/ticket/{ticketId}", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/api/ticket/{ticketId}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/api/ticket/{ticketId}");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  'https://auvious.video/api/ticket/{ticketId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://auvious.video/api/ticket/{ticketId}',
  params: {}, headers: headers

p JSON.parse(result)

Rotate a ticket

POST https://auvious.video/api/ticket/{ticketId}/rotate HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Rotate a ticket and return its replacement. The replacement inherits stable ticket identity from the original, applies policy-allowed replacement properties, and uses either expiresAt or properties.ttl for generic validity. Service-only rotate responses return the full persisted successor ticket; public manage lookup returns a sanitized view.

Request body

{
  "organizationId": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": {},
    "property2": {}
  }
}

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	none
body	body	RotateTicketWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Ticket
400	Bad Request	Bad Request	Ticket
401	Unauthorized	Unauthorized	Ticket
403	Forbidden	Forbidden	Ticket
404	Not Found	Not Found	Ticket
409	Conflict	Conflict	Ticket

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X POST https://auvious.video/api/ticket/{ticketId}/rotate \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/api/ticket/{ticketId}/rotate", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "organizationId": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": {},
    "property2": {}
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/api/ticket/{ticketId}/rotate', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/api/ticket/{ticketId}/rotate");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/api/ticket/{ticketId}/rotate',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/api/ticket/{ticketId}/rotate',
  params: {}, headers: headers

p JSON.parse(result)

Revoke a ticket

POST https://auvious.video/api/ticket/{ticketId}/revoke HTTP/1.1
Host: auvious.video
Content-Type: application/json

Revoke a ticket. If someone tries to use this ticket he will get 'error_description'='REVOKED'

Request body

{
  "organizationId": "string"
}

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	none
body	body	RevokeTicketWebCommand	false	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X POST https://auvious.video/api/ticket/{ticketId}/revoke \
  -H 'Content-Type: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/api/ticket/{ticketId}/revoke", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "organizationId": "string"
}';
const headers = {
  'Content-Type': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/api/ticket/{ticketId}/revoke', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/api/ticket/{ticketId}/revoke");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/api/ticket/{ticketId}/revoke',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/api/ticket/{ticketId}/revoke',
  params: {}, headers: headers

p JSON.parse(result)

Enable a ticket

POST https://auvious.video/api/ticket/{ticketId}/enable HTTP/1.1
Host: auvious.video

Enable a ticket.

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X POST https://auvious.video/api/ticket/{ticketId}/enable \
  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/api/ticket/{ticketId}/enable", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/api/ticket/{ticketId}/enable', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/api/ticket/{ticketId}/enable");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/api/ticket/{ticketId}/enable',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/api/ticket/{ticketId}/enable',
  params: {}, headers: headers

p JSON.parse(result)

Disable a ticket

POST https://auvious.video/api/ticket/{ticketId}/disable HTTP/1.1
Host: auvious.video

Disable a ticket. If someone tries to use this ticket he will get 'error_description'='DISABLED'

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X POST https://auvious.video/api/ticket/{ticketId}/disable \
  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/api/ticket/{ticketId}/disable", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/api/ticket/{ticketId}/disable', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/api/ticket/{ticketId}/disable");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/api/ticket/{ticketId}/disable',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/api/ticket/{ticketId}/disable',
  params: {}, headers: headers

p JSON.parse(result)

Create a ticket

POST https://auvious.video/api/ticket HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Create a new ticket. Supported ticket families include single-use, multi-use, schedule, and appointments-manage tickets; lifecycle and usage semantics vary by type. Service-only create responses return the full persisted ticket, including ticket properties.

Request body

{
  "type": "GENESYS_SINGLE_USE_TICKET",
  "organizationId": "string",
  "properties": {
    "property1": {},
    "property2": {}
  },
  "expiresAt": "2019-08-24T14:15:22Z",
  "length": 6,
  "grouping": true,
  "disabled": true,
  "mode": "LETTERS_ONLY"
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateTicketWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Ticket

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X POST https://auvious.video/api/ticket \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("POST", "https://auvious.video/api/ticket", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');
const input = '{
  "type": "GENESYS_SINGLE_USE_TICKET",
  "organizationId": "string",
  "properties": {
    "property1": {},
    "property2": {}
  },
  "expiresAt": "2019-08-24T14:15:22Z",
  "length": 6,
  "grouping": true,
  "disabled": true,
  "mode": "LETTERS_ONLY"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/api/ticket', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/api/ticket");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Content-Type': 'application/json',
  'Accept': '*/*',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'https://auvious.video/api/ticket',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://auvious.video/api/ticket',
  params: {}, headers: headers

p JSON.parse(result)

Add to calendar

GET https://auvious.video/api/ticket/{ticketId}/event HTTP/1.1
Host: auvious.video
Accept: text/calendar
X-Forwarded-Proto: https
Host: string

Add to calendar

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	none
calendar	query	string	false	none
X-Forwarded-Proto	header	string	false	none
Host	header	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string

Examples

200 Response

caution

To perform this operation, you must be authenticated by means of one of the following methods: BearerToken, OAuth2ClientCredentials

Code samples

curl -X GET https://auvious.video/api/ticket/{ticketId}/event \
  -H 'Accept: text/calendar' \  -H 'X-Forwarded-Proto: https' \  -H 'Host: string' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Accept": []string{"text/calendar"},
        "X-Forwarded-Proto": []string{"https"},
        "Host": []string{"string"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    var body []byte
    // body = ...

    req, err := http.NewRequest("GET", "https://auvious.video/api/ticket/{ticketId}/event", bytes.NewBuffer(body))
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

const fetch = require('node-fetch');

const headers = {
  'Accept': 'text/calendar',  'X-Forwarded-Proto': 'https',  'Host': 'string',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video/api/ticket/{ticketId}/event', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://auvious.video/api/ticket/{ticketId}/event");

HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");

int responseCode = con.getResponseCode();

BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream())
);

String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();

System.out.println(response.toString());

import requests

headers = {
  'Accept': 'text/calendar',
  'X-Forwarded-Proto': 'https',
  'Host': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'https://auvious.video/api/ticket/{ticketId}/event',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'text/calendar',
  'X-Forwarded-Proto' => 'https',
  'Host' => 'string',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://auvious.video/api/ticket/{ticketId}/event',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

UpdateTicketWebCommand

{
  "organizationId": "string",
  "properties": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
organizationId	string	false	none	none
properties	object	true	none	none
» additionalProperties	object	false	none	none

Ticket

{
  "id": "string",
  "userId": "string",
  "organizationId": "string",
  "type": "GENESYS_SINGLE_USE_TICKET",
  "properties": {
    "property1": {},
    "property2": {}
  },
  "disabled": "2019-08-24T14:15:22Z",
  "revoked": "2019-08-24T14:15:22Z",
  "rotated": "2019-08-24T14:15:22Z",
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "version": 0,
  "expired": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
userId	string	false	none	none
organizationId	string	false	none	none
type	string	false	none	none
properties	object	false	none	none
» additionalProperties	object	false	none	none
disabled	string(date-time)	false	none	none
revoked	string(date-time)	false	none	none
rotated	string(date-time)	false	none	none
createdAt	string(date-time)	false	none	none
expiresAt	string(date-time)	false	none	none
version	integer(int64)	false	none	none
expired	boolean	false	none	none

Enumerated Values

Property	Value
type	GENESYS_SINGLE_USE_TICKET
type	GENESYS_MULTI_USE_TICKET
type	GENESYS_SCHEDULE_TICKET
type	MULTI_USE_TICKET
type	SCHEDULE_TICKET
type	APPOINTMENTS_SCHEDULE_TICKET
type	APPOINTMENTS_MANAGE_TICKET
type	SINGLE_USE_TICKET
type	SINGLE_USE_SCHEDULE_TICKET
type	SINGLE_USE_APPOINTMENTS_SCHEDULE_TICKET

RotateTicketWebCommand

{
  "organizationId": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "properties": {
    "property1": {},
    "property2": {}
  }
}

Request body for rotating a ticket. The replacement may set a generic expiresAt or properties.ttl validity boundary, and may provide policy-allowed replacement properties.

Properties

Name	Type	Required	Restrictions	Description
organizationId	string	false	none	Organization that owns the ticket.
expiresAt	string(date-time)	false	none	Absolute replacement ticket expiration timestamp. Mutually exclusive with properties.ttl.
properties	object	false	none	Policy-allowed replacement ticket properties. Ticket-type-specific data belongs here; opaque signed values are not interpreted by Auth.
» additionalProperties	object	false	none	Policy-allowed replacement ticket properties. Ticket-type-specific data belongs here; opaque signed values are not interpreted by Auth.

RevokeTicketWebCommand

{
  "organizationId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
organizationId	string	false	none	none

CreateTicketWebCommand

{
  "type": "GENESYS_SINGLE_USE_TICKET",
  "organizationId": "string",
  "properties": {
    "property1": {},
    "property2": {}
  },
  "expiresAt": "2019-08-24T14:15:22Z",
  "length": 6,
  "grouping": true,
  "disabled": true,
  "mode": "LETTERS_ONLY"
}

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	none
organizationId	string	false	none	none
properties	object	true	none	none
» additionalProperties	object	false	none	none
expiresAt	string(date-time)	false	none	Absolute ticket expiration timestamp. Mutually exclusive with properties.ttl; use this when the caller owns the exact validity boundary.
length	integer(int32)	false	none	none
grouping	boolean	false	none	none
disabled	boolean	false	none	none
mode	string	false	none	none

Enumerated Values

Property	Value
type	GENESYS_SINGLE_USE_TICKET
type	GENESYS_MULTI_USE_TICKET
type	GENESYS_SCHEDULE_TICKET
type	MULTI_USE_TICKET
type	SCHEDULE_TICKET
type	APPOINTMENTS_SCHEDULE_TICKET
type	APPOINTMENTS_MANAGE_TICKET
type	SINGLE_USE_TICKET
type	SINGLE_USE_SCHEDULE_TICKET
type	SINGLE_USE_APPOINTMENTS_SCHEDULE_TICKET
mode	LETTERS_ONLY
mode	NUMBERS_ONLY
mode	LETTERS_AND_NUMBERS

Authentication​

Tickets​

Get a ticket.​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Update a ticket​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Delete a ticket.​

Parameters​

Responses​

Overview​

Code samples​

Rotate a ticket​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Revoke a ticket​

Request body​

Parameters​

Responses​

Overview​

Code samples​

Enable a ticket​

Parameters​

Responses​

Overview​

Code samples​

Disable a ticket​

Parameters​

Responses​

Overview​

Code samples​

Create a ticket​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Add to calendar​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Schemas​

UpdateTicketWebCommand​

Properties​

Ticket​

Properties​

Enumerated Values​

RotateTicketWebCommand​

Properties​

RevokeTicketWebCommand​

Properties​

CreateTicketWebCommand​

Properties​

Enumerated Values​

Authentication

Tickets

Get a ticket.

Parameters

Responses

Overview

Examples

Code samples

Update a ticket

Request body

Parameters

Responses

Overview

Examples

Code samples

Delete a ticket.

Parameters

Responses

Overview

Code samples

Rotate a ticket

Request body

Parameters

Responses

Overview

Examples

Code samples

Revoke a ticket

Request body

Parameters

Responses

Overview

Code samples

Enable a ticket

Parameters

Responses

Overview

Code samples

Disable a ticket

Parameters

Responses

Overview

Code samples

Create a ticket

Request body

Parameters

Responses

Overview

Examples

Code samples

Add to calendar

Parameters

Responses

Overview

Examples

Code samples

Schemas

UpdateTicketWebCommand

Properties

Ticket

Properties

Enumerated Values

RotateTicketWebCommand

Properties

RevokeTicketWebCommand

Properties

CreateTicketWebCommand

Properties

Enumerated Values