Application v1.0

Manage Organization Applications

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

• OAuth 2.0 Authorization. Authenticate using client credentials

  • Flow: clientCredentials

  • OAuth 2.0 Authorization URL = https://auvious.video/security/oauth/authorize

  • OAuth 2.0 Token URL = https://auvious.video/security/oauth/token

  • OAuth 2.0 Scope

    Scope	Scope Description
    any	this is the default

• HTTP Authentication, scheme: bearer jwt bearer token access

Applications Service

Applications Controller

Get all available visible applications.

GET https://auvious.video:443/security/applications HTTP/1.1
Host: auvious.video:443
Accept: application/json

Parameters

Parameter	In	Type	Required	Description
offset	query	integer(int64)	false	none
pageNumber	query	integer(int32)	false	none
pageSize	query	integer(int32)	false	none
paged	query	boolean	false	none
sort.sorted	query	boolean	false	none
sort.unsorted	query	boolean	false	none
unpaged	query	boolean	false	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Inline
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Response Schema

Status Code 200

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

Enumerated Values

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

Examples

200 Response

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

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

Shell

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

Go

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", "https://auvious.video:443/security/applications", bytes.NewBuffer(body))
    req.Header = headers

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

Node

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

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

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

Java

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

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());

Python

import requests

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

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Create an application

POST https://auvious.video:443/security/applications HTTP/1.1
Host: auvious.video:443
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

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

Parameters

Parameter	In	Type	Required	Description
body	body	CreateApplicationWebCommand	false	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	CreateApplicationResponseValue
201	Created	Created	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

{
  "id": "string"
}

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

Shell

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

Go

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", "https://auvious.video:443/security/applications", bytes.NewBuffer(body))
    req.Header = headers

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

Node

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

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

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/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());

Python

import requests

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

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Delete an application.

DELETE https://auvious.video:443/security/applications/{applicationId} HTTP/1.1
Host: auvious.video:443

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
applicationId	path	string	true	applicationId

Responses

Overview

Status	Meaning	Description	Schema
204	No Content	No Content	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

Shell

curl -X DELETE https://auvious.video:443/security/applications/{applicationId} \
  -H 'Authorization: Bearer {access-token}'

Go

package main

import (
    "bytes"
    "net/http"
)

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

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

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

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

Node

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

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

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

Java

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

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());

Python

import requests

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

r = requests.delete(
  'https://auvious.video:443/security/applications/{applicationId}',
  params={},
  headers = headers)

print r.json()

Ruby

require 'rest-client'
require 'json'

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

result = RestClient.delete 'https://auvious.video:443/security/applications/{applicationId}',
  params: {}, headers: headers

p JSON.parse(result)

Read Application.

GET https://auvious.video:443/security/applications/{id} HTTP/1.1
Host: auvious.video:443
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	id

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	Application
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

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

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

Shell

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

Go

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", "https://auvious.video:443/security/applications/{id}", bytes.NewBuffer(body))
    req.Header = headers

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

Node

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

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

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

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/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());

Python

import requests

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

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Update an application

PUT https://auvious.video:443/security/applications/{id} HTTP/1.1
Host: auvious.video:443
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

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

Parameters

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

Responses

Overview

Status	Meaning	Description	Schema
201	Created	Created	None
204	No Content	Updated	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

caution

To perform this operation, you must be authenticated by means of one of the following methods: Client Credentials Flow ( Scopes: global ), Jwt ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global ), None ( Scopes: global )

Code samples

Shell

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

Go

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", "https://auvious.video:443/security/applications/{id}", bytes.NewBuffer(body))
    req.Header = headers

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

Node

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

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

Java

// This sample needs improvement.
URL obj = new URL("https://auvious.video:443/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());

Python

import requests

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

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

print r.json()

Ruby

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Schemas

Application

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

Application

Properties

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

Enumerated Values

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

CreateApplicationResponseValue

{
  "id": "string"
}

CreateApplicationResponseValue

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none

CreateApplicationWebCommand

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

CreateApplicationWebCommand

Properties

Name	Type	Required	Restrictions	Description
config	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
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

Enumerated Values

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

UpdateApplicationWebCommand

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

UpdateApplicationWebCommand

Properties

Name	Type	Required	Restrictions	Description
config	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
organizationId	string	false	none	only for access from internal service
type	string	true	none	none

Enumerated Values

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