Client v1.0

Manage Organization Clients (client credentials)

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://dev.auvious.video/security/oauth/authorize
- OAuth 2.0 Token URL = https://dev.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

Scope	Scope Description
any	this is the default

Clients

Clients Controller

List clients of user organization

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

Use this to retrieve all clients for your organization

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	[ClientResponseValue]	false	none	none
» ClientResponseValue	ClientResponseValue	false	none	none
»» clientId	string	false	none	none
»» clientSecret	string	false	none	none
»» description	string	false	none	none

Examples

200 Response

[
  {
    "clientId": "string",
    "clientSecret": "string",
    "description": "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

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

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

print r.json()

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Create a client

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

Use this to create a new client

Request body

{
  "description": "string"
}

Parameters

Parameter	In	Type	Required	Description
body	body	CreateClientWebCommand	false	none

Responses

Overview

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

Examples

200 Response

{
  "clientId": "string",
  "clientSecret": "string",
  "description": "string"
}

caution

Code samples

curl -X POST https://dev.auvious.video:443/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", "https://dev.auvious.video:443/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"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

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

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

p JSON.parse(result)

Delete client of user organization

DELETE https://dev.auvious.video:443/security/clients/{clientId} HTTP/1.1
Host: dev.auvious.video:443

Use this to delete a client for your organization

Parameters

Parameter	In	Type	Required	Description
clientId	path	string	true	clientId

Responses

Overview

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

caution

Code samples

curl -X DELETE https://dev.auvious.video:443/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", "https://dev.auvious.video:443/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('https://dev.auvious.video:443/security/clients/{clientId}', {
  method: 'DELETE',
  headers
})
.then(r => r.json())
.then((body) => {
    console.log(body)
})

// This sample needs improvement.
URL obj = new URL("https://dev.auvious.video:443/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(
  'https://dev.auvious.video:443/security/clients/{clientId}',
  params={},
  headers = headers)

print r.json()

require 'rest-client'
require 'json'

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

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

p JSON.parse(result)

Schemas

ClientResponseValue

{
  "clientId": "string",
  "clientSecret": "string",
  "description": "string"
}

ClientResponseValue

Properties

Name	Type	Required	Restrictions	Description
clientId	string	false	none	none
clientSecret	string	false	none	none
description	string	false	none	none

CreateClientWebCommand

{
  "description": "string"
}

CreateClientWebCommand

Properties

Name	Type	Required	Restrictions	Description
description	string	false	none	client description text

info

Authentication​

Clients​

List clients of user organization​

Responses​

Overview​

Response Schema​

Examples​

caution

Code samples​

Create a client​

Request body​

Parameters​

Responses​

Overview​

Examples​

caution

Code samples​

Delete client of user organization​

Parameters​

Responses​

Overview​

caution

Code samples​

Schemas​

ClientResponseValue​

Properties​

CreateClientWebCommand​

Properties​

Authentication

Clients

List clients of user organization

Responses

Overview

Response Schema

Examples

Code samples

Create a client

Request body

Parameters

Responses

Overview

Examples

Code samples

Delete client of user organization

Parameters

Responses

Overview

Code samples

Schemas

ClientResponseValue

Properties

CreateClientWebCommand

Properties