Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
import { Photon } from "@photon-ai/api";
const photon = new Photon({
headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
});
const result = await photon.auth.beginOrganizationClosureAuthentication({
path: {
orgId: "orgId",
},
body: {
returnTo: "returnTo",
},
});
import os
from photon_api import Photon
from photon_api.rpc_generated import BeginOrganizationClosureAuthenticationInput
photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
result = photon.auth.begin_organization_closure_authentication(
BeginOrganizationClosureAuthenticationInput.model_validate({
"path": {
"orgId": "orgId",
},
"body": {
"returnTo": "returnTo",
},
})
)
use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};
let token = std::env::var("PHOTON_API_TOKEN")?;
let client = PhotonClientBuilder::new()
.credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
.build()?;
let result = client
.begin_organization_closure_authentication(
"orgId".to_owned(),
&serde_json::from_value(serde_json::json!({
"returnTo": "returnTo",
}))?,
)
.await
.map_err(|error| format!("{error:?}"))?
.into_inner();
{
"url": "string"
}
Sign in to close organization: beginOrganizationClosureAuthentication in the TypeScript, Python and Rust clients.
import { Photon } from "@photon-ai/api";
const photon = new Photon({
headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
});
const result = await photon.auth.beginOrganizationClosureAuthentication({
path: {
orgId: "orgId",
},
body: {
returnTo: "returnTo",
},
});
import os
from photon_api import Photon
from photon_api.rpc_generated import BeginOrganizationClosureAuthenticationInput
photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
result = photon.auth.begin_organization_closure_authentication(
BeginOrganizationClosureAuthenticationInput.model_validate({
"path": {
"orgId": "orgId",
},
"body": {
"returnTo": "returnTo",
},
})
)
use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};
let token = std::env::var("PHOTON_API_TOKEN")?;
let client = PhotonClientBuilder::new()
.credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
.build()?;
let result = client
.begin_organization_closure_authentication(
"orgId".to_owned(),
&serde_json::from_value(serde_json::json!({
"returnTo": "returnTo",
}))?,
)
.await
.map_err(|error| format!("{error:?}"))?
.into_inner();
{
"url": "string"
}
POST /v1/auth/organizations/{orgId}/sso/closure-authenticate
Returns an authentication URL for the current organization owner to inspect organization closure. Supply returnTo and complete the returned flow. This operation initiates authentication and does not close the organization.
photon.auth.beginOrganizationClosureAuthentication(input: BeginOrganizationClosureAuthenticationInput, options?: RequestOptions): Promise<BeginOrganizationClosureAuthenticationOutput>
photon.auth.begin_organization_closure_authentication(input: BeginOrganizationClosureAuthenticationInput) -> models.OrganizationAuthenticationRedirect
client.begin_organization_closure_authentication(org_id: String, body: &types::OrganizationAuthenticationRequest).await -> Result<ResponseValue<types::OrganizationAuthenticationRedirect>, Error<BeginOrganizationClosureAuthenticationError>>
import { Photon } from "@photon-ai/api";
const photon = new Photon({
headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
});
const result = await photon.auth.beginOrganizationClosureAuthentication({
path: {
orgId: "orgId",
},
body: {
returnTo: "returnTo",
},
});
import os
from photon_api import Photon
from photon_api.rpc_generated import BeginOrganizationClosureAuthenticationInput
photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
result = photon.auth.begin_organization_closure_authentication(
BeginOrganizationClosureAuthenticationInput.model_validate({
"path": {
"orgId": "orgId",
},
"body": {
"returnTo": "returnTo",
},
})
)
use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};
let token = std::env::var("PHOTON_API_TOKEN")?;
let client = PhotonClientBuilder::new()
.credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
.build()?;
let result = client
.begin_organization_closure_authentication(
"orgId".to_owned(),
&serde_json::from_value(serde_json::json!({
"returnTo": "returnTo",
}))?,
)
.await
.map_err(|error| format!("{error:?}"))?
.into_inner();
{
"url": "string"
}
200 Targeted SSO authorization URL. OrganizationAuthenticationRedirect
Was this page helpful?