Transfer organization ownership to an existing member
curl --request POST \
--url https://api.photon.codes/v1/organizations/{organizationId}/transfer-ownership \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"expectedVersion": "<string>",
"newOwnerAccountId": "<string>"
}
'import requests
url = "https://api.photon.codes/v1/organizations/{organizationId}/transfer-ownership"
payload = {
"expectedVersion": "<string>",
"newOwnerAccountId": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({expectedVersion: '<string>', newOwnerAccountId: '<string>'})
};
fetch('https://api.photon.codes/v1/organizations/{organizationId}/transfer-ownership', 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.photon.codes/v1/organizations/{organizationId}/transfer-ownership",
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([
'expectedVersion' => '<string>',
'newOwnerAccountId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.photon.codes/v1/organizations/{organizationId}/transfer-ownership"
payload := strings.NewReader("{\n \"expectedVersion\": \"<string>\",\n \"newOwnerAccountId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://api.photon.codes/v1/organizations/{organizationId}/transfer-ownership")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedVersion\": \"<string>\",\n \"newOwnerAccountId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.photon.codes/v1/organizations/{organizationId}/transfer-ownership")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedVersion\": \"<string>\",\n \"newOwnerAccountId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"newOwner": {
"accountId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"joinedVia": "creation",
"organizationId": "<string>",
"removedAt": "2023-11-07T05:31:56Z",
"role": "owner",
"roleManagedAt": "2023-11-07T05:31:56Z",
"status": "active",
"updatedAt": "2023-11-07T05:31:56Z",
"version": "<string>"
},
"organizationVersion": "<string>",
"previousOwner": {
"accountId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"joinedVia": "creation",
"organizationId": "<string>",
"removedAt": "2023-11-07T05:31:56Z",
"role": "owner",
"roleManagedAt": "2023-11-07T05:31:56Z",
"status": "active",
"updatedAt": "2023-11-07T05:31:56Z",
"version": "<string>"
}
}{
"code": "INVALID_ARGUMENT",
"status": 400,
"title": "Invalid Argument",
"type": "https://photon.codes/docs/problems/invalid-argument"
}{
"code": "NOT_AUTHENTICATED",
"status": 401,
"title": "Not Authenticated",
"type": "https://photon.codes/docs/problems/not-authenticated"
}{
"code": "FORBIDDEN",
"status": 403,
"title": "Forbidden",
"type": "https://photon.codes/docs/problems/forbidden"
}{
"code": "ORGANIZATION_MEMBER_NOT_FOUND",
"status": 404,
"title": "Organization Member Not Found",
"type": "https://photon.codes/docs/problems/organization-member-not-found"
}{
"code": "ACCOUNT_CLOSING",
"status": 409,
"title": "Account Is Closing",
"type": "https://photon.codes/docs/problems/account-closing"
}{
"code": "VALIDATION_FAILED",
"issues": [
{
"code": "invalid_type",
"location": "json",
"message": "Expected a string.",
"path": "/name"
}
],
"status": 422,
"title": "Request Validation Failed",
"type": "https://photon.codes/docs/problems/validation-failed"
}{
"code": "INTERNAL_ERROR",
"status": 500,
"title": "Internal Server Error",
"type": "https://photon.codes/docs/problems/internal-error"
}{
"code": "UPSTREAM_FAILURE",
"status": 502,
"title": "Upstream Service Failure",
"type": "https://photon.codes/docs/problems/upstream-failure"
}{
"code": "UPSTREAM_UNAVAILABLE",
"status": 503,
"title": "Upstream Service Unavailable",
"type": "https://photon.codes/docs/problems/upstream-unavailable"
}{
"code": "UPSTREAM_TIMEOUT",
"status": 504,
"title": "Upstream Service Timeout",
"type": "https://photon.codes/docs/problems/upstream-timeout"
}Organization Members
Transfer organization ownership to an existing member
POST
/
v1
/
organizations
/
{organizationId}
/
transfer-ownership
Transfer organization ownership to an existing member
curl --request POST \
--url https://api.photon.codes/v1/organizations/{organizationId}/transfer-ownership \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"expectedVersion": "<string>",
"newOwnerAccountId": "<string>"
}
'import requests
url = "https://api.photon.codes/v1/organizations/{organizationId}/transfer-ownership"
payload = {
"expectedVersion": "<string>",
"newOwnerAccountId": "<string>"
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({expectedVersion: '<string>', newOwnerAccountId: '<string>'})
};
fetch('https://api.photon.codes/v1/organizations/{organizationId}/transfer-ownership', 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.photon.codes/v1/organizations/{organizationId}/transfer-ownership",
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([
'expectedVersion' => '<string>',
'newOwnerAccountId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-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.photon.codes/v1/organizations/{organizationId}/transfer-ownership"
payload := strings.NewReader("{\n \"expectedVersion\": \"<string>\",\n \"newOwnerAccountId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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://api.photon.codes/v1/organizations/{organizationId}/transfer-ownership")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"expectedVersion\": \"<string>\",\n \"newOwnerAccountId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.photon.codes/v1/organizations/{organizationId}/transfer-ownership")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"expectedVersion\": \"<string>\",\n \"newOwnerAccountId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"newOwner": {
"accountId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"joinedVia": "creation",
"organizationId": "<string>",
"removedAt": "2023-11-07T05:31:56Z",
"role": "owner",
"roleManagedAt": "2023-11-07T05:31:56Z",
"status": "active",
"updatedAt": "2023-11-07T05:31:56Z",
"version": "<string>"
},
"organizationVersion": "<string>",
"previousOwner": {
"accountId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"joinedVia": "creation",
"organizationId": "<string>",
"removedAt": "2023-11-07T05:31:56Z",
"role": "owner",
"roleManagedAt": "2023-11-07T05:31:56Z",
"status": "active",
"updatedAt": "2023-11-07T05:31:56Z",
"version": "<string>"
}
}{
"code": "INVALID_ARGUMENT",
"status": 400,
"title": "Invalid Argument",
"type": "https://photon.codes/docs/problems/invalid-argument"
}{
"code": "NOT_AUTHENTICATED",
"status": 401,
"title": "Not Authenticated",
"type": "https://photon.codes/docs/problems/not-authenticated"
}{
"code": "FORBIDDEN",
"status": 403,
"title": "Forbidden",
"type": "https://photon.codes/docs/problems/forbidden"
}{
"code": "ORGANIZATION_MEMBER_NOT_FOUND",
"status": 404,
"title": "Organization Member Not Found",
"type": "https://photon.codes/docs/problems/organization-member-not-found"
}{
"code": "ACCOUNT_CLOSING",
"status": 409,
"title": "Account Is Closing",
"type": "https://photon.codes/docs/problems/account-closing"
}{
"code": "VALIDATION_FAILED",
"issues": [
{
"code": "invalid_type",
"location": "json",
"message": "Expected a string.",
"path": "/name"
}
],
"status": 422,
"title": "Request Validation Failed",
"type": "https://photon.codes/docs/problems/validation-failed"
}{
"code": "INTERNAL_ERROR",
"status": 500,
"title": "Internal Server Error",
"type": "https://photon.codes/docs/problems/internal-error"
}{
"code": "UPSTREAM_FAILURE",
"status": 502,
"title": "Upstream Service Failure",
"type": "https://photon.codes/docs/problems/upstream-failure"
}{
"code": "UPSTREAM_UNAVAILABLE",
"status": 503,
"title": "Upstream Service Unavailable",
"type": "https://photon.codes/docs/problems/upstream-unavailable"
}{
"code": "UPSTREAM_TIMEOUT",
"status": 504,
"title": "Upstream Service Timeout",
"type": "https://photon.codes/docs/problems/upstream-timeout"
}Authorizations
Account Service Key, prefixed with pho_ask_, sent as Authorization: Bearer <key>. Acts on behalf of its owning account, subject to the permissions and credential restrictions of each operation. Account access tokens and OAuth grants also use the Bearer header. In organizations that require SSO, Account Service Keys are not accepted for managing the organization's SSO settings, deleting the organization, or checking whether it can be deleted.
Headers
Identifies one logical mutation across retries.
Required string length:
1 - 255Pattern:
^[\x21-\x7e]{1,255}$Path Parameters
Body
application/json
Was this page helpful?
⌘I