Skip to content
Authrim

Update an organization.

PUT
/api/admin/organizations/{id}
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/organizations/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "Platform Engineering", "is_active": true, "metadata_json": { "cost_center": "platform" } }'

Updates mutable organization fields such as name, display name, plan, type, active state, and metadata. Invalid plan or org_type values return invalid_request.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
>= 1 properties
name
string
>= 1 characters
display_name
string | null
plan
string
org_type
string
is_active
boolean
metadata_json
object
key
additional properties
key
additional properties
Example 
{
  "display_name": "Platform Engineering",
  "is_active": true,
  "metadata_json": {
    "cost_center": "platform"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Organization response.

Media type application/json
object
organization
required
object
id
required
string
tenant_id
required
string
name
required
string
display_name
required
string | null
parent_org_id
required
string | null
path
required
string
depth
required
integer
org_type
required
string
metadata_json
object
key
additional properties
is_active
required
boolean
created_at
required
integer format: int64
updated_at
required
integer format: int64
member_count
integer
key
additional properties
key
additional properties
Example 
{
  "organization": {
    "id": "org_acme",
    "tenant_id": "default",
    "name": "engineering",
    "display_name": "Engineering",
    "parent_org_id": null,
    "path": "/engineering",
    "depth": 0,
    "org_type": "department",
    "metadata_json": {},
    "is_active": true,
    "created_at": 1770000000,
    "updated_at": 1770000000,
    "member_count": 12
  }
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}