Get UserInvitation - Confidence Documentation

GET

/

v1

/

userInvitations

/

{userInvitation}

Get UserInvitation

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

import requests

url = "https://iam.eu.confidence.dev/v1/userInvitations/{userInvitation}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://iam.eu.confidence.dev/v1/userInvitations/{userInvitation}', 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/userInvitations/{userInvitation}",
  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/userInvitations/{userInvitation}"

	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/userInvitations/{userInvitation}")

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

{
  "invitedEmail": "<string>",
  "expirationTime": {},
  "invitationUri": "<string>",
  "invitationToken": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "inviter": "<string>",
  "ttl": {},
  "disableInvitationEmail": true,
  "labels": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

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

Path Parameters

userInvitation

string

required

Response

200 - application/json

OK

invitedEmail

string

required

The email to the send the invitation to

expirationTime

object

required

The absolute time that the invite expires and is no longer valid.

invitationUri

string

required

URI for accepting the invite.

invitationToken

string

required

Token required to accept the invite (part of the URI).

createTime

object

required

Time when the user invitation was first created.

updateTime

object

required

Time when the user invitation was last updated.

creator

string

required

Reference to the identity that created this user invitation.

updater

string

required

Reference to the identity that last updated this user invitation.

name

string

Name of the invitation on the form userInvitations/{"<"}id{">"}.

inviter

string

The person that initiated the invite. The email sent to invited_email will contain this name. If not sent and the token is an end user token the name of the currently logged in user will be used. Required if the token is an API client token.

ttl

object

The duration from create that the invite expires and is no longer valid. Defaults to 7 days if not specified.

disableInvitationEmail

boolean

If true, no email will be sent with the invitation link.

labels

object[]

General labels for this resource.

Show child attributes

⌘I

Get UserInvitation

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

import requests

url = "https://iam.eu.confidence.dev/v1/userInvitations/{userInvitation}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

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

fetch('https://iam.eu.confidence.dev/v1/userInvitations/{userInvitation}', 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/userInvitations/{userInvitation}",
  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/userInvitations/{userInvitation}"

	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/userInvitations/{userInvitation}")

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

{
  "invitedEmail": "<string>",
  "expirationTime": {},
  "invitationUri": "<string>",
  "invitationToken": "<string>",
  "createTime": {},
  "updateTime": {},
  "creator": "<string>",
  "updater": "<string>",
  "name": "<string>",
  "inviter": "<string>",
  "ttl": {},
  "disableInvitationEmail": true,
  "labels": [
    {}
  ]
}