Pular para o conteúdo principal
PATCH
/
workspaces
/
{workspaceId}
/
organizations
/
{organizationId}
Atualizar uma organização
curl --request PATCH \
  --url https://api.altostrat.io/workspaces/{workspaceId}/organizations/{organizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Equipe de Marketing Global",
  "billing_account_id": "cus_a1b2c3d4e5f6g7h8",
  "limits": {
    "users": 100,
    "locations": null
  },
  "picture": "https://example.com/new_logo.png",
  "branding": {
    "display_name": "ACME Inc.",
    "login_hint": "acme-inc",
    "colors": {
      "primary": "#007bff"
    }
  }
}'
{
  "id": "org_aBcDeFg123456789",
  "name": "Departamento de Engenharia",
  "workspace_id": "ws_a1b2c3d4e5f6g7h8",
  "external_id": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "parent_org_id": "org_zYxWvUt987654321",
  "path": "org_root123#org_parent456",
  "depth": 2,
  "billing_account_id": "cus_a1b2c3d4e5f6g7h8",
  "picture": "https://cdn.altostrat.io/logos/engineering.png",
  "usage": {
    "usage": {
      "locations": 2,
      "users": 5
    },
    "subtree_usage": {
      "locations": 10,
      "users": 25
    }
  },
  "limits": {
    "locations": 10,
    "users": 50
  },
  "branding": {
    "display_name": "ACME Corp",
    "login_hint": "acme-corp",
    "colors": {
      "primary": "#FF5733",
      "page_background": "#FFFFFF"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Insira seu JWT no formato: Bearer {token}

Path Parameters

​
workspaceId
string
required

O ID do workspace.

Example:

"ws_a1b2c3d4e5f6g7h8"

​
organizationId
string
required

O ID da organização.

Example:

"org_aBcDeFg123456789"

Body

application/json

Forneça um ou mais campos para atualizar. Os campos não fornecidos permanecerão inalterados.

​
name
string

O novo nome para a organização. Máximo de 50 caracteres.

Example:

"Equipe de Marketing Global"

​
billing_account_id
string

O ID da conta de faturamento a ser associada a uma organização raiz.

Example:

"cus_a1b2c3d4e5f6g7h8"

​
limits
object

Atualize os limites de recursos. Para remover um limite, passe a chave com um valor null.

Example:
{ "users": 100, "locations": null }
​
picture
string | null

Uma URL HTTPS pública ou URI de dados base64 para o novo logotipo. Para remover o logotipo, forneça null.

Example:

"https://example.com/new_logo.png"

​
branding
object

Configurações de branding para a organização.

Response

O objeto da organização atualizado.

​
id
string

Identificador único para a organização (corresponde ao ID da organização Auth0), prefixado com org_.

Example:

"org_aBcDeFg123456789"

​
name
string

O nome legível por humanos da organização.

Example:

"Departamento de Engenharia"

​
workspace_id
string

O ID do workspace ao qual esta organização pertence.

Example:

"ws_a1b2c3d4e5f6g7h8"

​
external_id
string<uuid>

Um identificador estável e único para a organização, independente de seu ID Auth0.

Example:

"a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d"

​
parent_org_id
string | null

O ID da organização pai, se esta for uma organização filha.

Example:

"org_zYxWvUt987654321"

​
path
string | null

Uma string separada por # representando o caminho hierárquico dos ancestrais.

Example:

"org_root123#org_parent456"

​
depth
integer

A profundidade da organização na hierarquia (0 para nível superior).

Example:

2

​
billing_account_id
string | null

O ID da conta de faturamento à qual esta organização está associada (no modo assigned).

Example:

"cus_a1b2c3d4e5f6g7h8"

​
picture
string<uri> | null

Uma URL para o logotipo da organização.

Example:

"https://cdn.altostrat.io/logos/engineering.png"

​
usage
object
​
limits
object

Um mapa de limites de recursos aplicados diretamente a esta organização. As chaves são tipos mensuráveis (locations, users, sso). Um valor null ou uma chave ausente significa que nenhum limite está definido neste nível. Um valor 0 significa que o recurso está explicitamente desativado.

Example:
{ "locations": 10, "users": 50 }
​
branding
object