Accept an invitation
curl --request POST \
--url https://api.smokeball.com/invitations/{id}/accept \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '
{
"password": "<string>",
"provider": "Auth0",
"mfaEnrollmentGraceDays": 30
}
'import requests
url = "https://api.smokeball.com/invitations/{id}/accept"
payload = {
"password": "<string>",
"provider": "Auth0",
"mfaEnrollmentGraceDays": 30
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
Authorization: '<api-key>',
'Content-Type': 'application/json-patch+json'
},
body: JSON.stringify({password: '<string>', provider: 'Auth0', mfaEnrollmentGraceDays: 30})
};
fetch('https://api.smokeball.com/invitations/{id}/accept', 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://api.smokeball.com/invitations/{id}/accept",
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([
'password' => '<string>',
'provider' => 'Auth0',
'mfaEnrollmentGraceDays' => 30
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json-patch+json",
"x-api-key: <api-key>"
],
]);
$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://api.smokeball.com/invitations/{id}/accept"
payload := strings.NewReader("{\n \"password\": \"<string>\",\n \"provider\": \"Auth0\",\n \"mfaEnrollmentGraceDays\": 30\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+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://api.smokeball.com/invitations/{id}/accept")
.header("x-api-key", "<api-key>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"password\": \"<string>\",\n \"provider\": \"Auth0\",\n \"mfaEnrollmentGraceDays\": 30\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smokeball.com/invitations/{id}/accept")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"password\": \"<string>\",\n \"provider\": \"Auth0\",\n \"mfaEnrollmentGraceDays\": 30\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Invitations
Accept an invitation
Server-to-server clients only. Creates the invited personās login under the invited email
address, with a user id derived from the invitation, and registers it with the firm; omit
password to have the identity provider email them a way to set one. Repeating the request,
even after the invitationās expiry, answers the same reply and creates the login once.
POST
/
invitations
/
{id}
/
accept
Accept an invitation
curl --request POST \
--url https://api.smokeball.com/invitations/{id}/accept \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json-patch+json' \
--header 'x-api-key: <api-key>' \
--data '
{
"password": "<string>",
"provider": "Auth0",
"mfaEnrollmentGraceDays": 30
}
'import requests
url = "https://api.smokeball.com/invitations/{id}/accept"
payload = {
"password": "<string>",
"provider": "Auth0",
"mfaEnrollmentGraceDays": 30
}
headers = {
"x-api-key": "<api-key>",
"Authorization": "<api-key>",
"Content-Type": "application/json-patch+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-api-key': '<api-key>',
Authorization: '<api-key>',
'Content-Type': 'application/json-patch+json'
},
body: JSON.stringify({password: '<string>', provider: 'Auth0', mfaEnrollmentGraceDays: 30})
};
fetch('https://api.smokeball.com/invitations/{id}/accept', 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://api.smokeball.com/invitations/{id}/accept",
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([
'password' => '<string>',
'provider' => 'Auth0',
'mfaEnrollmentGraceDays' => 30
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json-patch+json",
"x-api-key: <api-key>"
],
]);
$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://api.smokeball.com/invitations/{id}/accept"
payload := strings.NewReader("{\n \"password\": \"<string>\",\n \"provider\": \"Auth0\",\n \"mfaEnrollmentGraceDays\": 30\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json-patch+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://api.smokeball.com/invitations/{id}/accept")
.header("x-api-key", "<api-key>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json-patch+json")
.body("{\n \"password\": \"<string>\",\n \"provider\": \"Auth0\",\n \"mfaEnrollmentGraceDays\": 30\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smokeball.com/invitations/{id}/accept")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json-patch+json'
request.body = "{\n \"password\": \"<string>\",\n \"provider\": \"Auth0\",\n \"mfaEnrollmentGraceDays\": 30\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"href": "<string>",
"relation": "<string>",
"method": "GET"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Path Parameters
Unique identifier of the invitation to accept.
Body
application/json-patch+jsonapplication/jsonapplication/*+json
The credential to create the login with.
The credential the invited person's login is created with.
Password with a lowercase, uppercase, numeric and special character; omit it to have the identity provider email the person a way to set one.
Where the login is created: Default (when omitted) or Auth0.
Example:
"Auth0"
Number of days after creation during which the user may sign in without setting up multi-factor authentication. Once the period ends, enrolment is required at the next sign-in. Between 1 and 90. Auth0 users only; ignored for other providers.
When omitted: enrolment is required at the first sign-in.
Example:
30