Skip to main content
PATCH
Update organization
You are reading the docs of Galtea 5.15. Read this page in the latest version.

Authorizations

Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Headers

Prefer
string

Send return=minimal to get no body back from a write and skip reading the resource: a create answers 201 with only Location, and an update answers 204.

Example:

"return=minimal"

Path Parameters

id
string
required

Organization ID

Example:

"org_123"

Body

application/json
name
string

The organization name. Only a platform admin may change it.

Example:

"Example Organization"

warningAt
integer | null

The credit balance below which members get a low-credit warning, from 0 up to the monthly credits of the plan. Null turns the warning off.

Example:

100

enforceMfa
boolean

When true, every member of the organization must complete an MFA challenge to sign in.

samlEntrypointUrl
string | null

An in-house SAML sign-in setting. Only an organization with an ENTERPRISE subscription may change it.

samlEntityId
string | null

An in-house SAML sign-in setting. Only an organization with an ENTERPRISE subscription may change it.

samlIssuerId
string | null

An in-house SAML sign-in setting. Only an organization with an ENTERPRISE subscription may change it.

samlPublicCertificate
string | null

An in-house SAML sign-in setting. Only an organization with an ENTERPRISE subscription may change it.

samlSignedResponse
boolean | null

An in-house SAML sign-in setting. Only an organization with an ENTERPRISE subscription may change it.

samlSignedAssertions
boolean | null

An in-house SAML sign-in setting. Only an organization with an ENTERPRISE subscription may change it.

samlForcePasswordAuth
boolean | null

An in-house SAML sign-in setting. Only an organization with an ENTERPRISE subscription may change it.

otelProductKey
string[]

The resource attributes that identify a product of this organization, 1 to 10 names. Each product gives its own value for each of them. A name cannot start with "galtea." or be "customer.id". Changing the set of names is refused while a product that uses this key holds values. It cannot be null.

Example:
otelVersionAttributes
string[]

The resource attributes whose values make up a version, up to 32 names. A trace that carries no galtea.version.id and no galtea.version.fact.* gets the version built from the listed attributes it carries. Each fact keeps the attribute name as its key. A name cannot start with "galtea." or be "customer.id". An empty list turns this off. A product can replace the list with its own.

Example:
otelInputSourceRule
object | null

Recovers a turn's input from a non-LLM span for every product with no rule of its own. A version rule wins over a product rule, and a product rule over this one. Null clears it.

Example:
otelOutputSourceRule
object | null

Recovers a turn's output from a non-LLM span for every product with no rule of its own. A version rule wins over a product rule, and a product rule over this one. Null clears it.

Example:

Response

Organization updated successfully. The body is the resource as its GET answers it.

id
string
Example:

"org_123"

name
string
Example:

"Example Organization"

remainingSubscriptionCredits
integer | null
Example:

1000

extraCredits
integer
Example:

500

lastWarningAt
string<date-time> | null
warningAt
integer | null

The credit balance below which members get a low-credit warning, from 0 up to the monthly credits of the plan. Null turns the warning off.

Example:

100

stripeCustomerId
string | null
Example:

"cus_123"

samlEntrypointUrl
string | null
samlEntityId
string | null
samlIssuerId
string | null
samlPublicCertificate
string | null
samlSignedResponse
boolean | null
samlSignedAssertions
boolean | null
samlForcePasswordAuth
boolean | null
samlTeamSlug
string | null
enforceMfa
boolean
default:false

When true, every member of the organization must complete an MFA challenge to sign in. Settable by Owners (via update) and Admins (via create or update).

createdAt
string<date-time>
deletedAt
string<date-time> | null
otelProductKey
string[]

The resource attributes that identify a product of this organization, 1 to 10 names. Each product gives its own value for each of them. A name cannot start with "galtea." or be "customer.id". Changing the set of names is refused while a product that uses this key holds values. It cannot be null.

Example:
otelVersionAttributes
string[]

The resource attributes whose values make up a version, up to 32 names. A trace that carries no galtea.version.id and no galtea.version.fact.* gets the version built from the listed attributes it carries. Each fact keeps the attribute name as its key. A name cannot start with "galtea." or be "customer.id". An empty list turns this off. A product can replace the list with its own.

Example:
otelInputSourceRule
object | null

Recovers a turn's input from a non-LLM span for every product with no rule of its own. A version rule wins over a product rule, and a product rule over this one. Null clears it.

otelOutputSourceRule
object | null

Recovers a turn's output from a non-LLM span for every product with no rule of its own. A version rule wins over a product rule, and a product rule over this one. Null clears it.