Create
curl --request POST \
--url https://devx.{environment}.oleria.io/v1/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"applicationInstanceId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"primaryEmail": "<string>",
"username": "<string>",
"activate": true,
"displayName": "<string>",
"generatePassword": true,
"groups": [
"<string>"
],
"password": "<string>",
"secondaryEmail": "<string>",
"userPrincipalName": "<string>"
}
'import requests
url = "https://devx.{environment}.oleria.io/v1/accounts"
payload = {
"applicationInstanceId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"primaryEmail": "<string>",
"username": "<string>",
"activate": True,
"displayName": "<string>",
"generatePassword": True,
"groups": ["<string>"],
"password": "<string>",
"secondaryEmail": "<string>",
"userPrincipalName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
applicationInstanceId: '<string>',
firstName: '<string>',
lastName: '<string>',
primaryEmail: '<string>',
username: '<string>',
activate: true,
displayName: '<string>',
generatePassword: true,
groups: ['<string>'],
password: '<string>',
secondaryEmail: '<string>',
userPrincipalName: '<string>'
})
};
fetch('https://devx.{environment}.oleria.io/v1/accounts', 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://devx.{environment}.oleria.io/v1/accounts",
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([
'applicationInstanceId' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'primaryEmail' => '<string>',
'username' => '<string>',
'activate' => true,
'displayName' => '<string>',
'generatePassword' => true,
'groups' => [
'<string>'
],
'password' => '<string>',
'secondaryEmail' => '<string>',
'userPrincipalName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://devx.{environment}.oleria.io/v1/accounts"
payload := strings.NewReader("{\n \"applicationInstanceId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"primaryEmail\": \"<string>\",\n \"username\": \"<string>\",\n \"activate\": true,\n \"displayName\": \"<string>\",\n \"generatePassword\": true,\n \"groups\": [\n \"<string>\"\n ],\n \"password\": \"<string>\",\n \"secondaryEmail\": \"<string>\",\n \"userPrincipalName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://devx.{environment}.oleria.io/v1/accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"applicationInstanceId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"primaryEmail\": \"<string>\",\n \"username\": \"<string>\",\n \"activate\": true,\n \"displayName\": \"<string>\",\n \"generatePassword\": true,\n \"groups\": [\n \"<string>\"\n ],\n \"password\": \"<string>\",\n \"secondaryEmail\": \"<string>\",\n \"userPrincipalName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://devx.{environment}.oleria.io/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"applicationInstanceId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"primaryEmail\": \"<string>\",\n \"username\": \"<string>\",\n \"activate\": true,\n \"displayName\": \"<string>\",\n \"generatePassword\": true,\n \"groups\": [\n \"<string>\"\n ],\n \"password\": \"<string>\",\n \"secondaryEmail\": \"<string>\",\n \"userPrincipalName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"jobId": "9f2b1c7e-5a84-4d6b-9c31-0e7f8a2d4b16",
"self": "/v1/action-jobs/9f2b1c7e-5a84-4d6b-9c31-0e7f8a2d4b16"
}{
"code": "BAD_REQUEST",
"message": "The request was malformed."
}{
"code": "UNAUTHORIZED",
"message": "Missing or invalid authentication token."
}{
"code": "FORBIDDEN",
"message": "The token lacks the required scope."
}{
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded. Retry after the specified interval."
}{
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred."
}Accounts
Create
Creates an account in the application named by applicationInstanceId. This is the one write that carries a body: there is no existing account to address, so the new account’s details have to be supplied. The change is applied in the source system asynchronously: this returns a job, and the job reports the outcome, including whether the target could be changed at all. Requires the https://devx.{environment}.oleria.io/write scope.
POST
/
v1
/
accounts
Create
curl --request POST \
--url https://devx.{environment}.oleria.io/v1/accounts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"applicationInstanceId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"primaryEmail": "<string>",
"username": "<string>",
"activate": true,
"displayName": "<string>",
"generatePassword": true,
"groups": [
"<string>"
],
"password": "<string>",
"secondaryEmail": "<string>",
"userPrincipalName": "<string>"
}
'import requests
url = "https://devx.{environment}.oleria.io/v1/accounts"
payload = {
"applicationInstanceId": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"primaryEmail": "<string>",
"username": "<string>",
"activate": True,
"displayName": "<string>",
"generatePassword": True,
"groups": ["<string>"],
"password": "<string>",
"secondaryEmail": "<string>",
"userPrincipalName": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
applicationInstanceId: '<string>',
firstName: '<string>',
lastName: '<string>',
primaryEmail: '<string>',
username: '<string>',
activate: true,
displayName: '<string>',
generatePassword: true,
groups: ['<string>'],
password: '<string>',
secondaryEmail: '<string>',
userPrincipalName: '<string>'
})
};
fetch('https://devx.{environment}.oleria.io/v1/accounts', 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://devx.{environment}.oleria.io/v1/accounts",
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([
'applicationInstanceId' => '<string>',
'firstName' => '<string>',
'lastName' => '<string>',
'primaryEmail' => '<string>',
'username' => '<string>',
'activate' => true,
'displayName' => '<string>',
'generatePassword' => true,
'groups' => [
'<string>'
],
'password' => '<string>',
'secondaryEmail' => '<string>',
'userPrincipalName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://devx.{environment}.oleria.io/v1/accounts"
payload := strings.NewReader("{\n \"applicationInstanceId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"primaryEmail\": \"<string>\",\n \"username\": \"<string>\",\n \"activate\": true,\n \"displayName\": \"<string>\",\n \"generatePassword\": true,\n \"groups\": [\n \"<string>\"\n ],\n \"password\": \"<string>\",\n \"secondaryEmail\": \"<string>\",\n \"userPrincipalName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://devx.{environment}.oleria.io/v1/accounts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"applicationInstanceId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"primaryEmail\": \"<string>\",\n \"username\": \"<string>\",\n \"activate\": true,\n \"displayName\": \"<string>\",\n \"generatePassword\": true,\n \"groups\": [\n \"<string>\"\n ],\n \"password\": \"<string>\",\n \"secondaryEmail\": \"<string>\",\n \"userPrincipalName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://devx.{environment}.oleria.io/v1/accounts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"applicationInstanceId\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"primaryEmail\": \"<string>\",\n \"username\": \"<string>\",\n \"activate\": true,\n \"displayName\": \"<string>\",\n \"generatePassword\": true,\n \"groups\": [\n \"<string>\"\n ],\n \"password\": \"<string>\",\n \"secondaryEmail\": \"<string>\",\n \"userPrincipalName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"jobId": "9f2b1c7e-5a84-4d6b-9c31-0e7f8a2d4b16",
"self": "/v1/action-jobs/9f2b1c7e-5a84-4d6b-9c31-0e7f8a2d4b16"
}{
"code": "BAD_REQUEST",
"message": "The request was malformed."
}{
"code": "UNAUTHORIZED",
"message": "Missing or invalid authentication token."
}{
"code": "FORBIDDEN",
"message": "The token lacks the required scope."
}{
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded. Retry after the specified interval."
}{
"code": "INTERNAL_ERROR",
"message": "An unexpected error occurred."
}Authorizations
OAuth 2.0 client-credentials flow. Request an access token from the token endpoint and send it as Authorization: Bearer <token>.
Body
application/json
Response
The change was accepted and is being applied. Poll the returned job for its outcome.

