Auvious Auth Server API v1.8.8-beta.0

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

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

Examples

200 Response

{
  "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

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
404	Not Found	Not Found	None

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

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("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',  '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',
  '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',
  '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

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

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

package main

import (
    "bytes"
    "net/http"
)

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

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

    req, err := http.NewRequest("DELETE", "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 = {
  '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 = {
  '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 = {
  '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

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

200 Response

[
  {
    "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

Examples

200 Response

{
  "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)

Schemas

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

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

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​

Applications​

Get Application.​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Update an application​

Request body​

Parameters​

Responses​

Overview​

Code samples​

Delete application.​

Parameters​

Responses​

Overview​

Code samples​

Get all available visible applications.​

Parameters​

Responses​

Overview​

Response Schema​

Enumerated Values​

Examples​

Code samples​

Create an application​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Schemas​

UpdateApplicationWebCommand​

Properties​

Enumerated Values​

CreateApplicationWebCommand​

Properties​

Enumerated Values​

CreateApplicationResponseValue​

Properties​

Pageable​

Properties​

Application​

Properties​

Enumerated Values​

Authentication

Applications

Get Application.

Parameters

Responses

Overview

Examples

Code samples

Update an application

Request body

Parameters

Responses

Overview

Code samples

Delete application.

Parameters

Responses

Overview

Code samples

Get all available visible applications.

Parameters

Responses

Overview

Response Schema

Enumerated Values

Examples

Code samples

Create an application

Request body

Parameters

Responses

Overview

Examples

Code samples

Schemas

UpdateApplicationWebCommand

Properties

Enumerated Values

CreateApplicationWebCommand

Properties

Enumerated Values

CreateApplicationResponseValue

Properties

Pageable

Properties

Application

Properties

Enumerated Values