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

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

Examples

200 Response

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

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

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 '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/clients/{clientId}", 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/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 = {
  '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 = {
  '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

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

200 Response

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

Examples

200 Response

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

Examples

200 Response

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

Schemas

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

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

Authentication​

Clients​

Update a client​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Delete client of user organization​

Parameters​

Responses​

Overview​

Code samples​

List clients of user organization​

Responses​

Overview​

Response Schema​

Examples​

Code samples​

Create a client​

Request body​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Rotate client secret​

Parameters​

Responses​

Overview​

Examples​

Code samples​

Schemas​

UpdateClientWebCommand​

Properties​

ClientId​

Properties​

ClientResponseValue​

Properties​

CreateClientWebCommand​

Properties​

Authentication

Clients

Update a client

Request body

Parameters

Responses

Overview

Examples

Code samples

Delete client of user organization

Parameters

Responses

Overview

Code samples

List clients of user organization

Responses

Overview

Response Schema

Examples

Code samples

Create a client

Request body

Parameters

Responses

Overview

Examples

Code samples

Rotate client secret

Parameters

Responses

Overview

Examples

Code samples

Schemas

UpdateClientWebCommand

Properties

ClientId

Properties

ClientResponseValue

Properties

CreateClientWebCommand

Properties