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

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

Examples

200 Response

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

Shell

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

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

Node

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)
})

Java

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

Python

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

Ruby

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

Examples

200 Response

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

Shell

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

Java

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

Python

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

Ruby

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)

Schemas

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

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