/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}
curl --request PUT \
--url https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"realm": "<string>",
"organization": "<string>",
"label": "<string>",
"identifier": "<string>",
"externalIdentifier": "<string>",
"location": [],
"values": [
"<unknown>"
],
"mask": "<string>",
"required": true,
"description": "<string>"
}
'import requests
url = "https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}"
payload = {
"realm": "<string>",
"organization": "<string>",
"label": "<string>",
"identifier": "<string>",
"externalIdentifier": "<string>",
"location": [],
"values": ["<unknown>"],
"mask": "<string>",
"required": True,
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
realm: '<string>',
organization: '<string>',
label: '<string>',
identifier: '<string>',
externalIdentifier: '<string>',
location: [],
values: ['<unknown>'],
mask: '<string>',
required: true,
description: '<string>'
})
};
fetch('https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}', 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.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'realm' => '<string>',
'organization' => '<string>',
'label' => '<string>',
'identifier' => '<string>',
'externalIdentifier' => '<string>',
'location' => [
],
'values' => [
'<unknown>'
],
'mask' => '<string>',
'required' => true,
'description' => '<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://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}"
payload := strings.NewReader("{\n \"realm\": \"<string>\",\n \"organization\": \"<string>\",\n \"label\": \"<string>\",\n \"identifier\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"location\": [],\n \"values\": [\n \"<unknown>\"\n ],\n \"mask\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"realm\": \"<string>\",\n \"organization\": \"<string>\",\n \"label\": \"<string>\",\n \"identifier\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"location\": [],\n \"values\": [\n \"<unknown>\"\n ],\n \"mask\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"realm\": \"<string>\",\n \"organization\": \"<string>\",\n \"label\": \"<string>\",\n \"identifier\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"location\": [],\n \"values\": [\n \"<unknown>\"\n ],\n \"mask\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyCustom Fields
/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}
PUT
/
realms
/
{realmId}
/
organizations
/
{organizationId}
/
custom-fields
/
{customFieldId}
/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}
curl --request PUT \
--url https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"realm": "<string>",
"organization": "<string>",
"label": "<string>",
"identifier": "<string>",
"externalIdentifier": "<string>",
"location": [],
"values": [
"<unknown>"
],
"mask": "<string>",
"required": true,
"description": "<string>"
}
'import requests
url = "https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}"
payload = {
"realm": "<string>",
"organization": "<string>",
"label": "<string>",
"identifier": "<string>",
"externalIdentifier": "<string>",
"location": [],
"values": ["<unknown>"],
"mask": "<string>",
"required": True,
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
realm: '<string>',
organization: '<string>',
label: '<string>',
identifier: '<string>',
externalIdentifier: '<string>',
location: [],
values: ['<unknown>'],
mask: '<string>',
required: true,
description: '<string>'
})
};
fetch('https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}', 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.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'realm' => '<string>',
'organization' => '<string>',
'label' => '<string>',
'identifier' => '<string>',
'externalIdentifier' => '<string>',
'location' => [
],
'values' => [
'<unknown>'
],
'mask' => '<string>',
'required' => true,
'description' => '<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://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}"
payload := strings.NewReader("{\n \"realm\": \"<string>\",\n \"organization\": \"<string>\",\n \"label\": \"<string>\",\n \"identifier\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"location\": [],\n \"values\": [\n \"<unknown>\"\n ],\n \"mask\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"realm\": \"<string>\",\n \"organization\": \"<string>\",\n \"label\": \"<string>\",\n \"identifier\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"location\": [],\n \"values\": [\n \"<unknown>\"\n ],\n \"mask\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.identity.v2.portao3.com.br/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"realm\": \"<string>\",\n \"organization\": \"<string>\",\n \"label\": \"<string>\",\n \"identifier\": \"<string>\",\n \"externalIdentifier\": \"<string>\",\n \"location\": [],\n \"values\": [\n \"<unknown>\"\n ],\n \"mask\": \"<string>\",\n \"required\": true,\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Minimum string length:
1Minimum string length:
1Available options:
TRANSACTION, SOLICITATION, CARD, WALLET, CUSTOMER, TRIP, TRAVEL_PASSENGER Available options:
TEXT, NUMBER, DATE, BOOLEAN, SELECT, MULTI_SELECT, CUSTOMER, FILE, MULTI_FILE, NF Available options:
ACTIVE, DEACTIVATED Response
default
Undocumented response (no code type, no existing spec).
/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}/realms/{realmId}/organizations/{organizationId}/custom-fields/{customFieldId}
⌘I