Get ApiClient - Confidence Documentation

GET

/

v1

/

apiClients

/

{apiClient}

Get ApiClient

curl --request GET \
  --url https://iam.eu.confidence.dev/v1/apiClients/{apiClient} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://iam.eu.confidence.dev/v1/apiClients/{apiClient}', 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://iam.eu.confidence.dev/v1/apiClients/{apiClient}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://iam.eu.confidence.dev/v1/apiClients/{apiClient}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://iam.eu.confidence.dev/v1/apiClients/{apiClient}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "displayName": "<string>",
  "clientId": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "identity": "<string>",
  "name": "<string>",
  "description": "<string>",
  "clientSecret": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

apiClient

string

required

Response

200 - application/json

Returns a ApiClient.

An API client that can be used to programmatically access the Confidence APIs.

displayName

string

required

Human friendly name of the API client.

clientId

string

required

Id of the API client.

createTime

object

required

Time when the API client was first created.

updateTime

object

required

Time when the API client was last updated.

creator

string

required

Reference to the identity that created this API client.

updater

string

required

Reference to the identity that last updated this API client.

identity

string

required

Reference to the identity this API client represents.

name

string

Name of the API client on the form apiClients/{"<"}id{">"}.

description

string

A description of the API client, e.g. what it is for.

clientSecret

string

The client secret for the client.

labels

object[]

General labels for this resource.

Show child attributes

owner

string

The owner of the resource. If not set will default to the creator.

⌘I

Get ApiClient

curl --request GET \
  --url https://iam.eu.confidence.dev/v1/apiClients/{apiClient} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://iam.eu.confidence.dev/v1/apiClients/{apiClient}', 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://iam.eu.confidence.dev/v1/apiClients/{apiClient}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://iam.eu.confidence.dev/v1/apiClients/{apiClient}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://iam.eu.confidence.dev/v1/apiClients/{apiClient}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "displayName": "<string>",
  "clientId": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "identity": "<string>",
  "name": "<string>",
  "description": "<string>",
  "clientSecret": "<string>",
  "labels": [
    {}
  ],
  "owner": "<string>"
}