SCIM
Provision a user
Needs permission user:write.
Invites the person across the whole account with your default role (Administrator until other roles can be given). 409 uniqueness when the userName or externalId is already in your account. Send an API token of your account as Authorization: Bearer <token>, with the user:write permission across the whole account (403 otherwise).
POST
/
scim
/
v2
/
Users
Provision a user
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://api.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users', 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.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-Auth-Token: <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"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Auth-Token", "<api-key>")
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.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users")
.header("X-Auth-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"meta": {
"resourceType": "<string>",
"location": "<string>",
"created": "<string>"
},
"schemas": [
"<string>"
],
"externalId": "<string>",
"userName": "<string>",
"name": {
"givenName": "<string>",
"familyName": "<string>",
"formatted": "<string>"
},
"displayName": "<string>",
"emails": [
{
"value": "<string>",
"type": "<string>",
"primary": true
}
],
"active": true
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}Was this page helpful?
⌘I
Provision a user
curl --request POST \
--url https://api.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users \
--header 'X-Auth-Token: <api-key>'import requests
url = "https://api.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://api.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users', 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.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-Auth-Token: <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"
"net/http"
"io"
)
func main() {
url := "https://api.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Auth-Token", "<api-key>")
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.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users")
.header("X-Auth-Token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.flowpayroll.ai/v1/administration/scim/v2/Users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Auth-Token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "<string>",
"meta": {
"resourceType": "<string>",
"location": "<string>",
"created": "<string>"
},
"schemas": [
"<string>"
],
"externalId": "<string>",
"userName": "<string>",
"name": {
"givenName": "<string>",
"familyName": "<string>",
"formatted": "<string>"
},
"displayName": "<string>",
"emails": [
{
"value": "<string>",
"type": "<string>",
"primary": true
}
],
"active": true
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}{
"status": "<string>",
"detail": "<string>",
"schemas": [
"<string>"
],
"scimType": "<string>"
}