PATCH /teams/{teamId}/integrations/{id}/
Nome, estado (active|paused|revoked), escopos, metadata
- Access: Team member
- Service:
https://api.axuz.net
Accepted authentication
sessionCookie— Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.bearerSession— JWT de acesso da sessão em `Authorization: Bearer`.
paused corta tokens e entregas na hora; revoked e TERMINAL (PATCH depois = 409 integration_revoked). Estreitar scopes reduz os tokens existentes (escopo efetivo = intersecao token x integracao).
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
teamId | path | string | yes | |
id | path | string | yes |
Request body
application/json · Required
| Name | Type | Required | Description |
|---|---|---|---|
name | string | no | |
state | string | no | enum: |
scopes | array<string> | no | |
metadata | object | no |
{
"name": "string",
"state": "active",
"scopes": [
"tasks:read"
],
"metadata": {}
}Responses
200
Atualizada
| Name | Type | Required | Description |
|---|---|---|---|
id | string<uuid> | yes | |
team_id | string<uuid> | yes | |
provider | string | yes | enum: |
name | string | yes | |
state | string | yes | enum: |
scopes | array<string> | yes | |
metadata | object | yes | NAO-secreta; <= 4 KiB. |
created_by | string<uuid> | no | |
created_at | string<date-time> | yes | |
updated_at | string<date-time> | yes | |
revoked_at | string<date-time> | no |
400
Corpo/parametro invalido (invalid, invalid_body, invalid_cursor...)
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
401
Sem credencial valida
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
403
Sem permissao (nao e owner/admin; token sem escopo; token de integracao em rota nao permitida)
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
404
Nao existe NESTE time (404 uniforme: nao vaza existencia entre times)
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
409
duplicate | conflict | integration_revoked
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
429
Limite de requisições excedido.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
500
Erro interno. Tente de novo com backoff; reporte o X-Request-Id.
| Name | Type | Required | Description |
|---|---|---|---|
error | string | yes |
Examples
"Try it" is turned off in this reference. Use the examples with your test credential.
curl
curl -sS -X PATCH 'https://api.axuz.net/teams/TEAM_ID/integrations/ID/' \
-H "Authorization: Bearer $AXUZ_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"string","state":"active","scopes":["tasks:read"],"metadata":{}}'Node.js
const res = await fetch("https://api.axuz.net/teams/TEAM_ID/integrations/ID/", {
method: 'PATCH',
headers: {
Authorization: `Bearer ${process.env.AXUZ_TOKEN}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"name": "string",
"state": "active",
"scopes": [
"tasks:read"
],
"metadata": {}
}),
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());Python
import os
import requests
res = requests.request(
"PATCH",
"https://api.axuz.net/teams/TEAM_ID/integrations/ID/",
headers={
"Authorization": f"Bearer {os.environ['AXUZ_TOKEN']}",
},
json={
"name": "string",
"state": "active",
"scopes": [
"tasks:read",
],
"metadata": {},
},
timeout=30,
)
res.raise_for_status()
print(res.json())