Auvious Auth Server API v1.8.8-beta.1.unchecked

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 = https://auvious.video/security/oauth/token
- OAuth 2.0 Scope
  Scope Scope Description

Tickets

Get a ticket.

GET http://auvious.video/security/ticket/{ticketId} HTTP/1.1
Host: auvious.video
Accept: */*

Get a ticket.

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	none

Responses

Overview

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

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X GET http://auvious.video/security/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", "http://auvious.video/security/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('http://auvious.video/security/ticket/{ticketId}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/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(
  'http://auvious.video/security/ticket/{ticketId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Update a ticket

PUT http://auvious.video/security/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
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X PUT http://auvious.video/security/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", "http://auvious.video/security/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('http://auvious.video/security/ticket/{ticketId}', {
  method: 'PUT',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/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(
  'http://auvious.video/security/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 'http://auvious.video/security/ticket/{ticketId}',
  params: {}, headers: headers

p JSON.parse(result)

Delete a ticket.

DELETE http://auvious.video/security/ticket/{ticketId} HTTP/1.1
Host: auvious.video
Accept: application/json

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
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X DELETE http://auvious.video/security/ticket/{ticketId} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

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

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

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

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

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

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/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 = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Create a ticket

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

Create a new ticket. It defines what will be the username and to which conference the user will have access to. The ticket will be deleted once it's used once to obtain a token

Request body

{
  "type": "GENESYS_SINGLE_USE_TICKET",
  "organizationId": "string",
  "properties": {
    "property1": {},
    "property2": {}
  },
  "length": 6,
  "disabled": true
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateTicketWebCommand	true	none

Responses

Overview

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

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X POST http://auvious.video/security/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", "http://auvious.video/security/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": {}
  },
  "length": 6,
  "disabled": true
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

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

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/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(
  'http://auvious.video/security/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 'http://auvious.video/security/ticket',
  params: {}, headers: headers

p JSON.parse(result)

Revoke a ticket

POST http://auvious.video/security/ticket/{ticketId}/revoke HTTP/1.1
Host: auvious.video
Accept: application/json

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

Parameters

Parameter	In	Type	Required	Description
ticketId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X POST http://auvious.video/security/ticket/{ticketId}/revoke \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

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

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

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

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

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

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/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 = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Enable a ticket

POST http://auvious.video/security/ticket/{ticketId}/enable HTTP/1.1
Host: auvious.video
Accept: application/json

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
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X POST http://auvious.video/security/ticket/{ticketId}/enable \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

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

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

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

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

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

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/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 = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Disable a ticket

POST http://auvious.video/security/ticket/{ticketId}/disable HTTP/1.1
Host: auvious.video
Accept: application/json

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
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X POST http://auvious.video/security/ticket/{ticketId}/disable \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

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

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

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

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

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

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/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 = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

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

print r.json()

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Add to calendar

GET http://auvious.video/security/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
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X GET http://auvious.video/security/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", "http://auvious.video/security/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('http://auvious.video/security/ticket/{ticketId}/event', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/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(
  'http://auvious.video/security/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 'http://auvious.video/security/ticket/{ticketId}/event',
  params: {}, headers: headers

p JSON.parse(result)

Clients

Update a client

PUT http://auvious.video/security/clients/{clientId} HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Use this to update description and/or roles of a new client

Request body

{
  "description": "string",
  "roles": [
    "string"
  ]
}

Parameters

Parameter	In	Type	Required	Description
clientId	path	ClientId	true	none
body	body	UpdateClientWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	ClientResponseValue
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

{
  "clientId": "string",
  "clientSecret": "string",
  "description": "string",
  "roles": [
    "string"
  ]
}

caution

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

Code samples

curl -X PUT http://auvious.video/security/clients/{clientId} \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("PUT", "http://auvious.video/security/clients/{clientId}", bytes.NewBuffer(body))
    req.Header = headers

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

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

fetch('http://auvious.video/security/clients/{clientId}', {
  method: 'PUT',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/clients/{clientId}");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put(
  'http://auvious.video/security/clients/{clientId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.put 'http://auvious.video/security/clients/{clientId}',
  params: {}, headers: headers

p JSON.parse(result)

Delete client of user organization

DELETE http://auvious.video/security/clients/{clientId} HTTP/1.1
Host: auvious.video
Accept: application/json

Use this to delete a client for your organization

Parameters

Parameter	In	Type	Required	Description
clientId	path	ClientId	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X DELETE http://auvious.video/security/clients/{clientId} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("DELETE", "http://auvious.video/security/clients/{clientId}", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('http://auvious.video/security/clients/{clientId}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/clients/{clientId}");

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 = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  'http://auvious.video/security/clients/{clientId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.delete 'http://auvious.video/security/clients/{clientId}',
  params: {}, headers: headers

p JSON.parse(result)

List clients of user organization

GET http://auvious.video/security/clients HTTP/1.1
Host: auvious.video
Accept: application/json

Use this to retrieve all clients for your organization

Responses

Overview

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

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[ClientResponseValue]	false	none	none
» clientId	string	false	none	none
» clientSecret	string	false	none	none
» description	string	false	none	none
» roles	[string]	false	none	none

Examples

[
  {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "roles": [
      "string"
    ]
  }
]

caution

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

Code samples

curl -X GET http://auvious.video/security/clients \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "http://auvious.video/security/clients", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('http://auvious.video/security/clients', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/clients");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'http://auvious.video/security/clients',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.get 'http://auvious.video/security/clients',
  params: {}, headers: headers

p JSON.parse(result)

Create a client

POST http://auvious.video/security/clients HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Use this to create a new client

Request body

{
  "description": "string",
  "roles": [
    "string"
  ]
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateClientWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	ClientResponseValue
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

{
  "clientId": "string",
  "clientSecret": "string",
  "description": "string",
  "roles": [
    "string"
  ]
}

caution

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

Code samples

curl -X POST http://auvious.video/security/clients \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

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

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

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

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

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/clients");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://auvious.video/security/clients',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.post 'http://auvious.video/security/clients',
  params: {}, headers: headers

p JSON.parse(result)

Rotate client secret

POST http://auvious.video/security/clients/{clientId}/rotate HTTP/1.1
Host: auvious.video
Accept: application/json

Use this to create new secret for client - USE WITH CAUTION

Parameters

Parameter	In	Type	Required	Description
clientId	path	ClientId	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	ClientResponseValue
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

{
  "clientId": "string",
  "clientSecret": "string",
  "description": "string",
  "roles": [
    "string"
  ]
}

caution

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

Code samples

curl -X POST http://auvious.video/security/clients/{clientId}/rotate \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("POST", "http://auvious.video/security/clients/{clientId}/rotate", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('http://auvious.video/security/clients/{clientId}/rotate', {
  method: 'POST',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/clients/{clientId}/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 = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://auvious.video/security/clients/{clientId}/rotate',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.post 'http://auvious.video/security/clients/{clientId}/rotate',
  params: {}, headers: headers

p JSON.parse(result)

Applications

Get Application.

GET http://auvious.video/security/applications/{id} HTTP/1.1
Host: auvious.video
Accept: application/json

Use this operation to get configuration. For type GENESYS apps, if you are an integration admin user you will have 'integrations:integration:view' permission which is what this method will check in order to return all configuration entries. Otherwise, if the user is a microservice it will get back only serviceParameters, if the user is a customer he will only get back customerParameters while if the user is a non-admin agent he will get only agentParameters back

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Application
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

{
  "version": 0,
  "id": "string",
  "organizationId": "string",
  "type": "GENESYS",
  "config": {
    "property1": {},
    "property2": {}
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "visible": true,
  "expiresAt": "2019-08-24T14:15:22Z"
}

caution

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

Code samples

curl -X GET http://auvious.video/security/applications/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "http://auvious.video/security/applications/{id}", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('http://auvious.video/security/applications/{id}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/applications/{id}");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'http://auvious.video/security/applications/{id}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.get 'http://auvious.video/security/applications/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Update an application

PUT http://auvious.video/security/applications/{id} HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Use this operation to update an existing application. For GENESYS type applications you should include your organizationId and pcEnvironment values. This operation will be denied if the user doesn't have the 'integrations:integration:edit' permission.

Request body

{
  "organizationId": "string",
  "type": "GENESYS",
  "config": {
    "property1": {},
    "property2": {}
  }
}

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	none
body	body	UpdateApplicationWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	Updated	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X PUT http://auvious.video/security/applications/{id} \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("PUT", "http://auvious.video/security/applications/{id}", bytes.NewBuffer(body))
    req.Header = headers

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

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

fetch('http://auvious.video/security/applications/{id}', {
  method: 'PUT',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/applications/{id}");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put(
  'http://auvious.video/security/applications/{id}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.put 'http://auvious.video/security/applications/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Delete application.

DELETE http://auvious.video/security/applications/{id} HTTP/1.1
Host: auvious.video
Accept: application/json

Use this if you want to delete an application. If the app is GENESYS type, the user must have the permission integrations:integration:delete permission, otherwise this call will fail.

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X DELETE http://auvious.video/security/applications/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("DELETE", "http://auvious.video/security/applications/{id}", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('http://auvious.video/security/applications/{id}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/applications/{id}");

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 = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete(
  'http://auvious.video/security/applications/{id}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.delete 'http://auvious.video/security/applications/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Get all available visible applications.

GET http://auvious.video/security/applications?pageable=page,0,size,1,sort,string HTTP/1.1
Host: auvious.video
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
pageable	query	Pageable	true	none

Responses

Overview

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

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Application]	false	none	none
» version	integer(int64)	false	none	none
» id	string	false	none	none
» organizationId	string	false	none	none
» type	string	false	none	none
» config	object	false	none	none
»» additionalProperties	object	false	none	none
» createdAt	string(date-time)	false	none	none
» visible	boolean	false	none	none
» expiresAt	string(date-time)	false	none	none

Enumerated Values

Property	Value
type	GENESYS
type	STANDALONE_OPENID
type	TALKDESK_OPENID
type	NICE_CXONE_OPENID
type	TEST
type	SETUP_TEST

Examples

[
  {
    "version": 0,
    "id": "string",
    "organizationId": "string",
    "type": "GENESYS",
    "config": {
      "property1": {},
      "property2": {}
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "visible": true,
    "expiresAt": "2019-08-24T14:15:22Z"
  }
]

caution

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

Code samples

curl -X GET http://auvious.video/security/applications?pageable=page,0,size,1,sort,string \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "http://auvious.video/security/applications", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('http://auvious.video/security/applications?pageable=page,0,size,1,sort,string', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/applications?pageable=page,0,size,1,sort,string");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'http://auvious.video/security/applications',
  params={
    'pageable': {
  "page": 0,
  "size": 1,
  "sort": [
    "string"
  ]
}},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.get 'http://auvious.video/security/applications',
  params: {
    'pageable' => '[Pageable](#schemapageable)'}, headers: headers

p JSON.parse(result)

Create an application

POST http://auvious.video/security/applications HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Use this operation to create a new application. For GENESYS type applications you should include at least your 'organizationId' and 'pcEnvironment' entries in the 'config' otherwise creation will be denied. It is also recommended to include 'integrationId' entry. Again for GENESYS type applications, this operation will check that the user has integrations:integration:add permission. Once more, for GENESYS type apps, you should include your parameters in three main entries: serviceParameters, agentParameters and customerParameters. You can include other parameters, but they will be visible to all members of the same organization as well as internal auvious services. Internal Services can create any application.

Request body

{
  "id": "string",
  "organizationId": "string",
  "type": "GENESYS",
  "config": {
    "property1": {},
    "property2": {}
  }
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateApplicationWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CreateApplicationResponseValue
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

{
  "id": "string"
}

caution

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

Code samples

curl -X POST http://auvious.video/security/applications \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

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

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

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

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

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/applications");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://auvious.video/security/applications',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.post 'http://auvious.video/security/applications',
  params: {}, headers: headers

p JSON.parse(result)

Talkdesk Service

Refresh a talkdesk access token.

POST http://auvious.video/security/talkdesk/refresh_token HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Refresh a Talkdesk access token. You need to provide a valid auvious bearer token in the Authorization header. The response will contain a new Talkdesk access token. The response is a typical oauth2 token response and is described at https://docs.talkdesk.com/reference/refresh-token-basic.

Request body

{
  "refresh_token": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	TalkdeskRefreshTokenRequest	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"string"

caution

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

Code samples

curl -X POST http://auvious.video/security/talkdesk/refresh_token \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("POST", "http://auvious.video/security/talkdesk/refresh_token", bytes.NewBuffer(body))
    req.Header = headers

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

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

fetch('http://auvious.video/security/talkdesk/refresh_token', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/talkdesk/refresh_token");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://auvious.video/security/talkdesk/refresh_token',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.post 'http://auvious.video/security/talkdesk/refresh_token',
  params: {}, headers: headers

p JSON.parse(result)

Otp Verification Service

Request an otp

POST http://auvious.video/security/otp HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*

Request a otp verification code. Returns an otp verification id which should be passed on calls that are protected with otp.

Request body

{
  "to": "+306957206309",
  "channel": "SMS",
  "customName": "hello, world",
  "locale": "en"
}

Parameters

Parameter	In	Type	Required	Description
body	body	RequestOtpCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	OtpRequestResult
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X POST http://auvious.video/security/otp \
  -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", "http://auvious.video/security/otp", bytes.NewBuffer(body))
    req.Header = headers

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

const fetch = require('node-fetch');
const input = '{
  "to": "+306957206309",
  "channel": "SMS",
  "customName": "hello, world",
  "locale": "en"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'Authorization': 'Bearer {access-token}'
}

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

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/otp");

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(
  'http://auvious.video/security/otp',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.post 'http://auvious.video/security/otp',
  params: {}, headers: headers

p JSON.parse(result)

Verify an otp

POST http://auvious.video/security/otp/verify HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Verify an otp verification code.

Request body

{
  "to": "+306957206309",
  "code": "123456",
  "verificationId": "1234567890"
}

Parameters

Parameter	In	Type	Required	Description
body	body	VerifyOtpCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X POST http://auvious.video/security/otp/verify \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("POST", "http://auvious.video/security/otp/verify", bytes.NewBuffer(body))
    req.Header = headers

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

const fetch = require('node-fetch');
const input = '{
  "to": "+306957206309",
  "code": "123456",
  "verificationId": "1234567890"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://auvious.video/security/otp/verify', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/otp/verify");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://auvious.video/security/otp/verify',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.post 'http://auvious.video/security/otp/verify',
  params: {}, headers: headers

p JSON.parse(result)

Nice Service

Refresh a nice access token.

POST http://auvious.video/security/nice/refresh_token HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Refresh a Nice CxOne access token. You need to provide a valid auvious bearer token in the Authorization header. The response will contain a new Nice access token and refresh token. The response is a typical oauth2 token response and is described at https://developer.niceincontact.com/Documentation/OpenIDConnectIntegration.

Request body

{
  "refresh_token": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	NiceRefreshTokenRequest	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	string
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"string"

caution

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

Code samples

curl -X POST http://auvious.video/security/nice/refresh_token \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("POST", "http://auvious.video/security/nice/refresh_token", bytes.NewBuffer(body))
    req.Header = headers

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

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

fetch('http://auvious.video/security/nice/refresh_token', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/nice/refresh_token");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://auvious.video/security/nice/refresh_token',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.post 'http://auvious.video/security/nice/refresh_token',
  params: {}, headers: headers

p JSON.parse(result)

Keys

Create a key

POST http://auvious.video/security/keys HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Use this to create a new key

Request body

{
  "type": "SSH_RSA",
  "organizationId": "string",
  "privateKey": "string",
  "publicKey": "string",
  "key": "string",
  "comment": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateKeyWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CreateKeyResult
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

{
  "id": "string",
  "publicKey": "string",
  "key": "string"
}

caution

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

Code samples

curl -X POST http://auvious.video/security/keys \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

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

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

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

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

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/keys");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://auvious.video/security/keys',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.post 'http://auvious.video/security/keys',
  params: {}, headers: headers

p JSON.parse(result)

Retrieve a key

GET http://auvious.video/security/keys/{id} HTTP/1.1
Host: auvious.video
Accept: application/json

Use this to retrieve a key, only services and admins are allowed, but private parts are hidden if not a service

Parameters

Parameter	In	Type	Required	Description
id	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Key
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

{
  "id": "string",
  "userId": "string",
  "organizationId": "string",
  "type": "SSH_RSA",
  "keySize": 0,
  "privateKey": "string",
  "publicKey": "string",
  "key": "string",
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}

caution

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

Code samples

curl -X GET http://auvious.video/security/keys/{id} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "http://auvious.video/security/keys/{id}", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('http://auvious.video/security/keys/{id}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/keys/{id}");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'http://auvious.video/security/keys/{id}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.get 'http://auvious.video/security/keys/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Facades Service

Create room,ticket and return ticket and agent urls

POST http://auvious.video/security/facades/room HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: application/json

Create a new room, ticket and return the urls. Allowed from trusted clients that have authenticated using client credentials. Ticket url expires by default after 4 hours.

Request body

{
  "organizationId": "string",
  "applicationId": "string",
  "urlBase": "string",
  "customerId": "string",
  "interactionId": "string",
  "cdestination": "mobile-office, interaction-widget, standalone, embedded, premise, callback",
  "ticketExpirationSeconds": 0,
  "ticketLength": 0
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateRoomWebCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CreateRoomResult
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

{
  "agentUrl": "string",
  "ticketUrl": "string",
  "recordingUrl": "string"
}

caution

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

Code samples

curl -X POST http://auvious.video/security/facades/room \
  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("POST", "http://auvious.video/security/facades/room", bytes.NewBuffer(body))
    req.Header = headers

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

const fetch = require('node-fetch');
const input = '{
  "organizationId": "string",
  "applicationId": "string",
  "urlBase": "string",
  "customerId": "string",
  "interactionId": "string",
  "cdestination": "mobile-office, interaction-widget, standalone, embedded, premise, callback",
  "ticketExpirationSeconds": 0,
  "ticketLength": 0
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('http://auvious.video/security/facades/room', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/facades/room");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://auvious.video/security/facades/room',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.post 'http://auvious.video/security/facades/room',
  params: {}, headers: headers

p JSON.parse(result)

Create a genesys callback (schedule)

POST http://auvious.video/security/facades/callback HTTP/1.1
Host: auvious.video
Content-Type: application/json
Accept: */*
X-OtpVerificationId: string
X-OtpCode: string
X-ApplicationId: string
X-UrlBase: string
X-Ticket-Expiration-Seconds: 0

Create a new genesys callback. Allowed with a valid otp code,verification id, or with client credentials. For request body schema check https://developer.genesys.cloud/api/rest/v2/conversations/#postConversationsCallbacks, with queueName added for convenience.

Request body

{
  "scriptId": "string",
  "queueId": "string",
  "queueName": "string",
  "routingData": {
    "queueId": "string",
    "queueName": "string",
    "languageId": "string",
    "priority": 0,
    "skillIds": [
      "string"
    ],
    "preferredAgentIds": [
      "string"
    ]
  },
  "callbackUserName": "string",
  "callbackNumbers": [
    "string"
  ],
  "callbackScheduledTime": "string",
  "countryCode": "string",
  "validateCallbackNumbers": true,
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

Parameters

Parameter	In	Type	Required	Description
X-OtpVerificationId	header	string	false	only for otp authentication
X-OtpCode	header	string	false	only for otp authentication
X-ApplicationId	header	string	true	mandatory, can be found at application settings page
X-UrlBase	header	string	false	mandatory when using client credentials, e.g. https://auvious.video
X-Ticket-Expiration-Seconds	header	integer(int32)	false	expiration seconds for ticket url (since the scheduled time). 4 hours (14400) is the default
body	body	CreateGenesysCallbackCommand	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CallbackResult
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

"{\"error\": \"description\"}"

caution

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

Code samples

curl -X POST http://auvious.video/security/facades/callback \
  -H 'Content-Type: application/json' \  -H 'Accept: */*' \  -H 'X-OtpVerificationId: string' \  -H 'X-OtpCode: string' \  -H 'X-ApplicationId: string' \  -H 'X-UrlBase: string' \  -H 'X-Ticket-Expiration-Seconds: 0' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

func main() {
    headers := map[string][]string{ 
        "Content-Type": []string{"application/json"},
        "Accept": []string{"*/*"},
        "X-OtpVerificationId": []string{"string"},
        "X-OtpCode": []string{"string"},
        "X-ApplicationId": []string{"string"},
        "X-UrlBase": []string{"string"},
        "X-Ticket-Expiration-Seconds": []string{"0"},
        "Authorization": []string{"Bearer {access-token}"},
    }

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

    req, err := http.NewRequest("POST", "http://auvious.video/security/facades/callback", bytes.NewBuffer(body))
    req.Header = headers

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

const fetch = require('node-fetch');
const input = '{
  "scriptId": "string",
  "queueId": "string",
  "queueName": "string",
  "routingData": {
    "queueId": "string",
    "queueName": "string",
    "languageId": "string",
    "priority": 0,
    "skillIds": [
      "string"
    ],
    "preferredAgentIds": [
      "string"
    ]
  },
  "callbackUserName": "string",
  "callbackNumbers": [
    "string"
  ],
  "callbackScheduledTime": "string",
  "countryCode": "string",
  "validateCallbackNumbers": true,
  "data": {
    "property1": "string",
    "property2": "string"
  }
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': '*/*',  'X-OtpVerificationId': 'string',  'X-OtpCode': 'string',  'X-ApplicationId': 'string',  'X-UrlBase': 'string',  'X-Ticket-Expiration-Seconds': '0',  'Authorization': 'Bearer {access-token}'
}

fetch('http://auvious.video/security/facades/callback', {
  method: 'POST',
  body: input,
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/facades/callback");

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': '*/*',
  'X-OtpVerificationId': 'string',
  'X-OtpCode': 'string',
  'X-ApplicationId': 'string',
  'X-UrlBase': 'string',
  'X-Ticket-Expiration-Seconds': '0',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post(
  'http://auvious.video/security/facades/callback',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => '*/*',
  'X-OtpVerificationId' => 'string',
  'X-OtpCode' => 'string',
  'X-ApplicationId' => 'string',
  'X-UrlBase' => 'string',
  'X-Ticket-Expiration-Seconds' => '0',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'http://auvious.video/security/facades/callback',
  params: {}, headers: headers

p JSON.parse(result)

Users

Find user

GET http://auvious.video/security/users/{userId} HTTP/1.1
Host: auvious.video
Accept: application/json

Use this to retrieve user by id (only allowed from internal services)

Parameters

Parameter	In	Type	Required	Description
userId	path	string	true	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	User
400	Bad Request	Bad Request	Inline
401	Unauthorized	Unauthorized	Inline
403	Forbidden	Forbidden	Inline
404	Not Found	Not Found	Inline

Response Schema

Examples

{
  "id": "string",
  "password": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "locked": true,
  "credentialsExpireAt": "2019-08-24T14:15:22Z",
  "disabled": true,
  "roles": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "lastSeenAt": "2019-08-24T14:15:22Z",
  "personalDataEntityId": "string",
  "version": 0,
  "enabled": true,
  "authorities": [
    {
      "authority": "string"
    }
  ],
  "username": "string",
  "accountNonExpired": true,
  "accountNonLocked": true,
  "credentialsNonExpired": true
}

caution

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

Code samples

curl -X GET http://auvious.video/security/users/{userId} \
  -H 'Accept: application/json' \  -H 'Authorization: Bearer {access-token}'

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("GET", "http://auvious.video/security/users/{userId}", bytes.NewBuffer(body))
    req.Header = headers

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

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

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

fetch('http://auvious.video/security/users/{userId}', {
  method: 'GET',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("http://auvious.video/security/users/{userId}");

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': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get(
  'http://auvious.video/security/users/{userId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

result = RestClient.get 'http://auvious.video/security/users/{userId}',
  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",
  "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
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	SINGLE_USE_TICKET
type	SINGLE_USE_SCHEDULE_TICKET
type	SINGLE_USE_APPOINTMENTS_SCHEDULE_TICKET

UpdateClientWebCommand

{
  "description": "string",
  "roles": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
description	string	false	none	new client description text (Optional - if not provided old one will remain).
roles	[string]	false	none	new client roles (Optional - if not provided old ones will remain). Valid values are: ClientService, Agent, Supervisor, Admin

ClientId

{
  "id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none

ClientResponseValue

{
  "clientId": "string",
  "clientSecret": "string",
  "description": "string",
  "roles": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
clientId	string	false	none	none
clientSecret	string	false	none	none
description	string	false	none	none
roles	[string]	false	none	none

UpdateApplicationWebCommand

{
  "organizationId": "string",
  "type": "GENESYS",
  "config": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
organizationId	string	false	none	only for access from internal service
type	string	true	none	none
config	object	true	none	The application configuration object. For GENESYS apps, serviceParameters will be shown only to service accounts and admins, agentParameters will only be shown to agents and customerParameters will be shown only to customers
» additionalProperties	object	false	none	The application configuration object. For GENESYS apps, serviceParameters will be shown only to service accounts and admins, agentParameters will only be shown to agents and customerParameters will be shown only to customers

Enumerated Values

Property	Value
type	GENESYS
type	STANDALONE_OPENID
type	TALKDESK_OPENID
type	NICE_CXONE_OPENID
type	TEST
type	SETUP_TEST

CreateTicketWebCommand

{
  "type": "GENESYS_SINGLE_USE_TICKET",
  "organizationId": "string",
  "properties": {
    "property1": {},
    "property2": {}
  },
  "length": 6,
  "disabled": true
}

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
length	integer(int32)	false	none	none
disabled	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	SINGLE_USE_TICKET
type	SINGLE_USE_SCHEDULE_TICKET
type	SINGLE_USE_APPOINTMENTS_SCHEDULE_TICKET

TalkdeskRefreshTokenRequest

{
  "refresh_token": "string"
}

Properties

Name	Type	Required	Restrictions	Description
refresh_token	string	false	none	none

RequestOtpCommand

{
  "to": "+306957206309",
  "channel": "SMS",
  "customName": "hello, world",
  "locale": "en"
}

Request OTP command

Properties

Name	Type	Required	Restrictions	Description
to	string	true	none	Where to?
channel	string	false	none	Channel to use
customName	string	false	none	custom name to use instead of default
locale	string	false	none	locale to use

Enumerated Values

Property	Value
to	any phone number, or email if supported
channel	UNKNOWN
channel	SMS
channel	VOICE
channel	EMAIL
channel	SMS
customName	any string, but keep it short
locale	af, ar, ca, cs, da, de, el, en, en-GB, es, fi, fr, he, hi, hr, hu, id, it, ja, ko, ms, nb, nl, pl, pt, pr-BR, ro, ru, sv, th, tl, tr, vi, zh, zh-CN, or zh-HK.

OtpRequestResult

{
  "id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none

VerifyOtpCommand

{
  "to": "+306957206309",
  "code": "123456",
  "verificationId": "1234567890"
}

Properties

Name	Type	Required	Restrictions	Description
to	string	true	none	User msisdn or email
code	string	true	none	The otp code
verificationId	string	true	none	Verification id

Enumerated Values

Property	Value
to	any phone number, or email if supported

NiceRefreshTokenRequest

{
  "refresh_token": "string"
}

Properties

Name	Type	Required	Restrictions	Description
refresh_token	string	false	none	none

CreateKeyWebCommand

{
  "type": "SSH_RSA",
  "organizationId": "string",
  "privateKey": "string",
  "publicKey": "string",
  "key": "string",
  "comment": "string"
}

create key web command model

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	key type, mandatory
organizationId	string	false	none	organizationId, optional, only supplied by internal services
privateKey	string	false	none	private key, include at least this if you want to import a key
publicKey	string	false	none	public key, include this optionally if you want to import a key
key	string	false	none	key include this if you want to import a symmetric type key
comment	string	false	none	key comment, supply this to include more information about the key

Enumerated Values

Property	Value
type	SSH_RSA

CreateKeyResult

{
  "id": "string",
  "publicKey": "string",
  "key": "string"
}

Result of keypair create operation

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	keypair id
publicKey	string	false	none	public key for asymmetric keys
key	string	false	none	key value, for symmetric keys

CreateRoomWebCommand

{
  "organizationId": "string",
  "applicationId": "string",
  "urlBase": "string",
  "customerId": "string",
  "interactionId": "string",
  "cdestination": "mobile-office, interaction-widget, standalone, embedded, premise, callback",
  "ticketExpirationSeconds": 0,
  "ticketLength": 0
}

Properties

Name	Type	Required	Restrictions	Description
organizationId	string	false	none	only for access from internal service
applicationId	string	true	none	which application to use
urlBase	string	true	none	which url base to use, e.g. https://auvious.video
customerId	string	false	none	customer id, e.g. interaction or conversation id
interactionId	string	false	none	conversation/interaction id
cdestination	string	false	none	${swagger.api.facades.commands.create-room.notes}
ticketExpirationSeconds	integer(int32)	false	none	ticket url expiration in seconds, 4 hours if not defined.
ticketLength	integer(int32)	false	none	ticket length override

Enumerated Values

Property	Value
cdestination	mobile-office, interaction-widget, standalone, embedded, premise, callback

CreateRoomResult

{
  "agentUrl": "string",
  "ticketUrl": "string",
  "recordingUrl": "string"
}

Properties

Name	Type	Required	Restrictions	Description
agentUrl	string	false	none	none
ticketUrl	string	false	none	none
recordingUrl	string	false	none	none

CreateGenesysCallbackCommand

{
  "scriptId": "string",
  "queueId": "string",
  "queueName": "string",
  "routingData": {
    "queueId": "string",
    "queueName": "string",
    "languageId": "string",
    "priority": 0,
    "skillIds": [
      "string"
    ],
    "preferredAgentIds": [
      "string"
    ]
  },
  "callbackUserName": "string",
  "callbackNumbers": [
    "string"
  ],
  "callbackScheduledTime": "string",
  "countryCode": "string",
  "validateCallbackNumbers": true,
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

check https://developer.genesys.cloud/api/rest/v2/conversations/#postConversationsCallbacks

Properties

Name	Type	Required	Restrictions	Description
scriptId	string	false	none	none
queueId	string	false	none	Id of queue where the callback will take place. You can omit this and use queueName if you find it difficult to locate the queue id.
queueName	string	false	none	Can be used instead of queueId, which is more convenient
routingData	RoutingData	false	none	none
callbackUserName	string	true	none	name of customer, which will be displayed on the agent workspace
callbackNumbers	[string]	true	none	phone number(s) of customer
callbackScheduledTime	string	false	none	The scheduled date-time for the callback as an ISO-8601 string yyyy-MM-ddTHH:mm:ss.SSSZ
countryCode	string	false	none	none
validateCallbackNumbers	boolean	false	none	none
data	object	false	none	none
» additionalProperties	string	false	none	none

RoutingData

{
  "queueId": "string",
  "queueName": "string",
  "languageId": "string",
  "priority": 0,
  "skillIds": [
    "string"
  ],
  "preferredAgentIds": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
queueId	string	false	none	none
queueName	string	false	none	none
languageId	string	false	none	none
priority	integer(int32)	false	none	none
skillIds	[string]	false	none	none
preferredAgentIds	[string]	false	none	none

CallbackIndentifier

{
  "type": "string",
  "id": "string"
}

The list of communication identifiers for the callback participants.

Properties

Name	Type	Required	Restrictions	Description
type	string	false	none	The type of the associated callback participant.Valid values: ACD, EXTERNAL.
id	string	false	none	The identifier of the callback.

CallbackResult

{
  "conferenceId": "string",
  "ticketId": "string",
  "agentUrl": "string",
  "ticketUrl": "string",
  "genesys": {
    "conversation": {
      "id": "string",
      "name": "string",
      "selfUri": "string"
    },
    "callbackIdentifiers": [
      {
        "type": "string",
        "id": "string"
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
conferenceId	string	false	none	the id of the conference created
ticketId	string	false	none	a ticket id which can be used to join the conference
agentUrl	string	false	none	a url for the agent to join
ticketUrl	string	false	none	a url for the customer to join
genesys	GenesysCreateCallbackResponse	false	none	Genesys create callback response

Conversation

{
  "id": "string",
  "name": "string",
  "selfUri": "string"
}

The conversation associated with the callback

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
name	string	false	none	none
selfUri	string	false	none	none

GenesysCreateCallbackResponse

{
  "conversation": {
    "id": "string",
    "name": "string",
    "selfUri": "string"
  },
  "callbackIdentifiers": [
    {
      "type": "string",
      "id": "string"
    }
  ]
}

Genesys create callback response

Properties

Name	Type	Required	Restrictions	Description
conversation	Conversation	false	none	The conversation associated with the callback
callbackIdentifiers	[CallbackIndentifier]	false	none	The list of communication identifiers for the callback participants.

CreateClientWebCommand

{
  "description": "string",
  "roles": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
description	string	false	none	client description text
roles	[string]	false	none	client roles (Optional). Valid values are: ClientService, Agent, Supervisor, Admin

CreateApplicationWebCommand

{
  "id": "string",
  "organizationId": "string",
  "type": "GENESYS",
  "config": {
    "property1": {},
    "property2": {}
  }
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	only for access from internal service
organizationId	string	false	none	only for access from internal service
type	string	true	none	none
config	object	true	none	The application configuration object. For GENESYS apps, serviceParameters will be shown only to service accounts and admins, agentParameters will only be shown to agents and customerParameters will be shown only to customers
» additionalProperties	object	false	none	The application configuration object. For GENESYS apps, serviceParameters will be shown only to service accounts and admins, agentParameters will only be shown to agents and customerParameters will be shown only to customers

Enumerated Values

Property	Value
type	GENESYS
type	STANDALONE_OPENID
type	TALKDESK_OPENID
type	NICE_CXONE_OPENID
type	TEST
type	SETUP_TEST

CreateApplicationResponseValue

{
  "id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none

GrantedAuthority

{
  "authority": "string"
}

Properties

Name	Type	Required	Restrictions	Description
authority	string	false	none	none

User

{
  "id": "string",
  "password": "string",
  "expiresAt": "2019-08-24T14:15:22Z",
  "locked": true,
  "credentialsExpireAt": "2019-08-24T14:15:22Z",
  "disabled": true,
  "roles": [
    "string"
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "lastSeenAt": "2019-08-24T14:15:22Z",
  "personalDataEntityId": "string",
  "version": 0,
  "enabled": true,
  "authorities": [
    {
      "authority": "string"
    }
  ],
  "username": "string",
  "accountNonExpired": true,
  "accountNonLocked": true,
  "credentialsNonExpired": true
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
password	string	false	none	none
expiresAt	string(date-time)	false	none	none
locked	boolean	false	none	none
credentialsExpireAt	string(date-time)	false	none	none
disabled	boolean	false	none	none
roles	[string]	false	none	none
createdAt	string(date-time)	false	none	none
lastSeenAt	string(date-time)	false	none	none
personalDataEntityId	string	false	none	none
version	integer(int64)	false	none	none
enabled	boolean	false	none	none
authorities	[GrantedAuthority]	false	none	none
username	string	false	none	none
accountNonExpired	boolean	false	none	none
accountNonLocked	boolean	false	none	none
credentialsNonExpired	boolean	false	none	none

Key

{
  "id": "string",
  "userId": "string",
  "organizationId": "string",
  "type": "SSH_RSA",
  "keySize": 0,
  "privateKey": "string",
  "publicKey": "string",
  "key": "string",
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z"
}

key entity

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	key reference id
userId	string	false	none	user id of creator
organizationId	string	false	none	organization id of creator
type	string	false	none	key type
keySize	integer(int32)	false	none	key size
privateKey	string	false	none	private part of key, if assymetric type
publicKey	string	false	none	public part of key, if assymetric type
key	string	false	none	key part for non assymetric keys
comment	string	false	none	key comment
createdAt	string(date-time)	false	none	creation timestamp

Enumerated Values

Property	Value
type	SSH_RSA

Pageable

{
  "page": 0,
  "size": 1,
  "sort": [
    "string"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
page	integer(int32)	false	none	none
size	integer(int32)	false	none	none
sort	[string]	false	none	none

Application

{
  "version": 0,
  "id": "string",
  "organizationId": "string",
  "type": "GENESYS",
  "config": {
    "property1": {},
    "property2": {}
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "visible": true,
  "expiresAt": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
version	integer(int64)	false	none	none
id	string	false	none	none
organizationId	string	false	none	none
type	string	false	none	none
config	object	false	none	none
» additionalProperties	object	false	none	none
createdAt	string(date-time)	false	none	none
visible	boolean	false	none	none
expiresAt	string(date-time)	false	none	none

Enumerated Values

Property	Value
type	GENESYS
type	STANDALONE_OPENID
type	TALKDESK_OPENID
type	NICE_CXONE_OPENID
type	TEST
type	SETUP_TEST

Authentication​

Tickets​

Get a ticket.​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Update a ticket​

Request body​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Delete a ticket.​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Create a ticket​

Request body​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Revoke a ticket​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Enable a ticket​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Disable a ticket​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Add to calendar​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Clients​

Update a client​

Request body​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Delete client of user organization​

Parameters​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

List clients of user organization​

Responses​

Overview​

Response Schema​

Authentication

Tickets

Get a ticket.

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Update a ticket

Request body

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Delete a ticket.

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Create a ticket

Request body

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Revoke a ticket

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Enable a ticket

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Disable a ticket

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Add to calendar

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Clients

Update a client

Request body

Parameters

Responses

Overview

Response Schema

Examples

Code samples

Delete client of user organization

Parameters

Responses

Overview

Response Schema

Examples

Code samples

List clients of user organization

Responses

Overview

Response Schema