Key v1.0

Manage Keys (used for sftp storage, etc..)

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

Keys

Keys Controller

Create a key

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

Use this to create a new key

Request body

{
  "comment": "string",
  "key": "string",
  "organizationId": "string",
  "privateKey": "string",
  "publicKey": "string",
  "type": "SSH_RSA"
}

Parameters

Parameter	In	Type	Required	Description
body	body	[create key web command model](#schemacreate key web command model)	false	none

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	[Result of keypair create operation](#schemaresult of keypair create operation)
201	Created	Created	None
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

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

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

Node

const fetch = require('node-fetch');
const input = '{
  "comment": "string",
  "key": "string",
  "organizationId": "string",
  "privateKey": "string",
  "publicKey": "string",
  "type": "SSH_RSA"
}';
const headers = {
  'Content-Type': 'application/json',  'Accept': 'application/json',  'Authorization': 'Bearer {access-token}'
}

fetch('https://auvious.video:443/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("https://auvious.video:443/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(
  'https://auvious.video:443/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 'https://auvious.video:443/security/keys',
  params: {}, headers: headers

p JSON.parse(result)

Retrieve a key

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

Responses

Overview

Status	Meaning	Description	Schema
200	OK	OK	[key entity](#schemakey entity)
401	Unauthorized	Unauthorized	None
403	Forbidden	Forbidden	None
404	Not Found	Not Found	None

Examples

200 Response

{
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "key": "string",
  "keySize": 0,
  "organizationId": "string",
  "privateKey": "string",
  "publicKey": "string",
  "type": "SSH_RSA",
  "userId": "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 GET https://auvious.video:443/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", "https://auvious.video:443/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('https://auvious.video:443/security/keys/{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/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(
  'https://auvious.video:443/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 'https://auvious.video:443/security/keys/{id}',
  params: {}, headers: headers

p JSON.parse(result)

Schemas

Result of keypair create operation

{
  "id": "string",
  "key": "string",
  "publicKey": "string"
}

Result of keypair create operation

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	keypair id
key	string	false	none	key value, for symmetric keys
publicKey	string	false	none	public key for asymmetric keys

create key web command model

{
  "comment": "string",
  "key": "string",
  "organizationId": "string",
  "privateKey": "string",
  "publicKey": "string",
  "type": "SSH_RSA"
}

create key web command model

Properties

Name	Type	Required	Restrictions	Description
comment	string	false	none	key comment, supply this to include more information about the key
key	string	false	none	key include this if you want to import a symmetric type key
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
type	string	false	none	key type, mandatory

Enumerated Values

Property	Value
type	SSH_RSA

key entity

{
  "comment": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "id": "string",
  "key": "string",
  "keySize": 0,
  "organizationId": "string",
  "privateKey": "string",
  "publicKey": "string",
  "type": "SSH_RSA",
  "userId": "string"
}

key entity

Properties

Name	Type	Required	Restrictions	Description
comment	string	false	none	key comment
createdAt	string(date-time)	false	none	creation timestamp
id	string	false	none	key reference id
key	string	false	none	key part for non assymetric keys
keySize	integer(int32)	false	none	key size
organizationId	string	false	none	organization id of creator
privateKey	string	false	none	private part of key, if assymetric type
publicKey	string	false	none	public part of key, if assymetric type
type	string	false	none	key type
userId	string	false	none	user id of creator

Enumerated Values

Property	Value
type	SSH_RSA