Post organisations credentials

POST

organisations

{organisationId}

credentials

cURL

curl --request POST \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "data": {},
  "type": "<string>",
  "redactFields": [
    "<string>"
  ],
  "expiresAt": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials"

payload = {
    "name": "<string>",
    "data": {},
    "type": "<string>",
    "redactFields": ["<string>"],
    "expiresAt": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    data: {},
    type: '<string>',
    redactFields: ['<string>'],
    expiresAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'data' => [
        
    ],
    'type' => '<string>',
    'redactFields' => [
        '<string>'
    ],
    'expiresAt' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"data\": {},\n  \"type\": \"<string>\",\n  \"redactFields\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"data\": {},\n  \"type\": \"<string>\",\n  \"redactFields\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"data\": {},\n  \"type\": \"<string>\",\n  \"redactFields\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "organisationID": "<unknown>",
  "name": "<string>",
  "data": {},
  "type": "<string>",
  "redactFields": [
    "<string>"
  ],
  "expiresAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "extensions": {}
}

Authorizations

Authorization

string

header

required

Path Parameters

organisationId

string

required

Body

application/json

CreateCredentialRequest is the request definition for creating a new credential.

CreateCredentialRequestBody is the request body to create a new credential. The ID is automatically generated and the organisation ID is defined by the request's path parameter.

name

string

required

Name is the credential name.

data

object

required

Data is a map of string keys to string base64 encoded values for the actual credential data.

type

string

required

Type provides additional context to what data the credential contains. Certain types dictate that certain fields must be set in order for the credential to be considered valid:

"Default" is the default type for a Credential. Data may contain arbitrary properties and will always be considered valid.
"OAuth2Refresh" signifies the credential is to be used for issuing OAuth 2.0 access tokens based on a refresh token. The credential data must json-marshal into a CredentialDataOAuth2Refresh in order to be valid. Credentials of this type may only be created or updated via the connections APIs, not by the credentials APIs.
"Raw" signifies the credential contains a value which can be used until the credential expires (or never if the credential has no expiry). The credential data must json-marshal into a CredentialDataRaw in order to be valid.
"BasicAuth" signifies the credential contains credentials to be used in HTTP Basic authentication schemes. The credential data must json-marshal into a CredentialDataBasicAuth in order to be valid.

redactFields

string[]

RedactFields is a list of fields within data which once created should not be returned to the user. This property is only applicable for "Default" credential types. Credentials of other types have their own redaction list internally and this field will be ignored.

expiresAt

string<date-time>

ExpiresAt allows the user to specify when Switchboard should automatically delete the credential.

Response

CreateCredentialResponse is the response containing the new credential.

Credential holds sensitive data not owned by Versori. Users can create credentials so that Versori systems can authenticate to external services on behalf of the user.

string

required

ID is the identifier for the credential.

organisationID

any

required

OrganisationID is the ID of the organisation which owns this credential.

name

string

required

Name is the credential name.

data

object

required

Data is a map of string keys to string base64 encoded values for the actual credential data.

type

string

required

Type provides additional context to what data the credential contains. Certain types dictate that certain fields must be set in order for the credential to be considered valid:

"Default" is the default type for a Credential. Data may contain arbitrary properties and will always be considered valid.
"OAuth2Refresh" signifies the credential is to be used for issuing OAuth 2.0 access tokens based on a refresh token. The credential data must json-marshal into a CredentialDataOAuth2Refresh in order to be valid. Credentials of this type may only be created or updated via the connections APIs, not by the credentials APIs.
"Raw" signifies the credential contains a value which can be used until the credential expires (or never if the credential has no expiry). The credential data must json-marshal into a CredentialDataRaw in order to be valid.
"BasicAuth" signifies the credential contains credentials to be used in HTTP Basic authentication schemes. The credential data must json-marshal into a CredentialDataBasicAuth in order to be valid.

redactFields

string[]

expiresAt

string<date-time>

ExpiresAt allows the user to specify when Switchboard should automatically delete the credential.

⌘I

cURL

curl --request POST \
  --url https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "data": {},
  "type": "<string>",
  "redactFields": [
    "<string>"
  ],
  "expiresAt": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials"

payload = {
    "name": "<string>",
    "data": {},
    "type": "<string>",
    "redactFields": ["<string>"],
    "expiresAt": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    data: {},
    type: '<string>',
    redactFields: ['<string>'],
    expiresAt: '2023-11-07T05:31:56Z'
  })
};

fetch('https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'data' => [
        
    ],
    'type' => '<string>',
    'redactFields' => [
        '<string>'
    ],
    'expiresAt' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"data\": {},\n  \"type\": \"<string>\",\n  \"redactFields\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"data\": {},\n  \"type\": \"<string>\",\n  \"redactFields\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.versori.com/api/switchboard/v1alpha1/organisations/{organisationId}/credentials")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"data\": {},\n  \"type\": \"<string>\",\n  \"redactFields\": [\n    \"<string>\"\n  ],\n  \"expiresAt\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "organisationID": "<unknown>",
  "name": "<string>",
  "data": {},
  "type": "<string>",
  "redactFields": [
    "<string>"
  ],
  "expiresAt": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "message": "<string>",
  "extensions": {}
}

boards

hubs

data-mappings

apps

operations

schemas

connections

credentials

Authorizations

Path Parameters

Body

Response