MCP-tool
API-sleutel verlengen
sosoapi_extend_api_keyStel een latere vervaldatum (expires_at) in voor een API-sleutel op id: maximaal 365 dagen vanaf nu, of 30 voor een door een agent gemaakte sleutel. Een agent kan alleen sleutels verlengen die met zijn eigen machtiging zijn gemaakt. Vereist de machtiging Manage API keys.
Lezen als MarkdownProfielen en transporten
Profielen: full · Transporten: stdio, http
Kies core of full om te bepalen welke tools je client ziet; dit verandert geen machtigingen. Lokale bestandsupload vereist stdio en is niet beschikbaar via HTTP. Stel SOSOAPI_OUTPUT_SCHEMAS=1 in om uitvoerschema's bij detectie op te nemen. Tools geven met en zonder die instelling gestructureerde resultaten terug.
Machtigingen en neveneffecten
Annotaties helpen clients een tool te beschrijven. Elke aanroep controleert nog steeds gebruikersauthenticatie, rol, resourcetoegang en verleende bevoegdheden.
{
"readOnlyHint": false,
"destructiveHint": false,
"idempotentHint": true,
"openWorldHint": false
}- /identity-api/api-keys/extend: agent:manage_api_keys · synchronous_http_response
Invoervelden
Verplicht betekent verplicht binnen het bovenliggende object en de gekozen variant. Een verplicht onderliggend veld maakt een optioneel bovenliggend object niet verplicht. Onderstaande regels en veldnamen zijn uit het contract gekopieerd.
| Veld / variant | Type / verplicht | Beperkingen |
|---|---|---|
$ | objectVerplicht in bovenliggend object |
|
id | stringVerplicht in bovenliggend object |
|
expires_at | stringVerplicht in bovenliggend object | Gevraagde nieuwe absolute vervaldatum. De maximale geldigheidsduur is 365 dagen vanaf nu, of 30 dagen voor een sleutel van een gedelegeerde agent. Een aangemelde persoon die de eigen sleutel verlengt, krijgt die maximale duur wanneer die om een latere datum vraagt (tot 3,650 dagen vanaf nu); in alle andere gevallen wordt een latere datum geweigerd met API_KEY_LIFETIME_EXCEEDS_CAP. Het antwoord bevat de werkelijk toegepaste vervaldatum.
|
Volledig JSON Schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"expires_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$",
"description": "Requested new absolute expiry. The longest lifetime is 365 days from now, or 30 days for a key created by a delegated agent. A signed-in person extending their own key is granted that longest lifetime when they ask for a later time (up to 3,650 days from now); in every other case a later time is refused with API_KEY_LIFETIME_EXCEEDS_CAP. The response carries the expiry actually applied."
}
},
"required": [
"id",
"expires_at"
],
"additionalProperties": false
}Gestructureerde uitvoer
Dit schema beschrijft structuredContent in een geslaagd toolresultaat. Het MCP-antwoord bevat ook content en kan isError instellen wanneer een aanroep mislukt. Lees bij publiceren het definitieve berichtresultaat; beschouw een geaccepteerd verzoek of tekstantwoord niet als bevestiging. De gekoppelde API-bewerking beschrijft machtigingen en regels voor opnieuw proberen.
Verplicht betekent verplicht binnen het bovenliggende object en de gekozen variant. Een verplicht onderliggend veld maakt een optioneel bovenliggend object niet verplicht. Onderstaande regels en veldnamen zijn uit het contract gekopieerd.
| Veld / variant | Type / verplicht | Beperkingen |
|---|---|---|
$ | objectVerplicht in bovenliggend object |
|
apiKey | objectVerplicht in bovenliggend object |
|
apiKey.id | stringVerplicht in bovenliggend object |
|
apiKey.name | stringVerplicht in bovenliggend object | — |
apiKey.last_4 | stringVerplicht in bovenliggend object | — |
apiKey.scopes | arrayVerplicht in bovenliggend object | — |
apiKey.scopes[] | stringOptioneel / item | — |
apiKey.created_at | stringVerplicht in bovenliggend object |
|
apiKey.expires_at | string | nullVerplicht in bovenliggend object | — |
apiKey.expires_atanyOf 1 | stringVerplicht in bovenliggend object |
|
apiKey.expires_atanyOf 2 | nullVerplicht in bovenliggend object | — |
apiKey.last_used_at | string | nullVerplicht in bovenliggend object | — |
apiKey.last_used_atanyOf 1 | stringVerplicht in bovenliggend object |
|
apiKey.last_used_atanyOf 2 | nullVerplicht in bovenliggend object | — |
apiKey.revoked_at | string | nullVerplicht in bovenliggend object | — |
apiKey.revoked_atanyOf 1 | stringVerplicht in bovenliggend object |
|
apiKey.revoked_atanyOf 2 | nullVerplicht in bovenliggend object | — |
apiKey.status | stringVerplicht in bovenliggend object |
|
apiKey.replaces | object | nullVerplicht in bovenliggend object | — |
apiKey.replacesanyOf 1 | objectVerplicht in bovenliggend object |
|
apiKey.replaces.idanyOf 1 | stringVerplicht in bovenliggend object |
|
apiKey.replaces.nameanyOf 1 | stringVerplicht in bovenliggend object | — |
apiKey.replaces.last_4anyOf 1 | stringVerplicht in bovenliggend object | — |
apiKey.replaces.statusanyOf 1 | stringVerplicht in bovenliggend object |
|
apiKey.replacesanyOf 2 | nullVerplicht in bovenliggend object | — |
apiKey.replaced_by | arrayVerplicht in bovenliggend object | — |
apiKey.replaced_by[] | objectOptioneel / item |
|
apiKey.replaced_by[].id | stringVerplicht in bovenliggend object |
|
apiKey.replaced_by[].name | stringVerplicht in bovenliggend object | — |
apiKey.replaced_by[].last_4 | stringVerplicht in bovenliggend object | — |
apiKey.replaced_by[].status | stringVerplicht in bovenliggend object |
|
apiKey.capabilities | arrayOptioneel / item | — |
apiKey.capabilities[] | stringOptioneel / item |
|
apiKey.workspace_ids | array | nullOptioneel / item | — |
apiKey.workspace_idsanyOf 1 | arrayOptioneel / item | — |
apiKey.workspace_ids[]anyOf 1 | stringOptioneel / item |
|
apiKey.workspace_idsanyOf 2 | nullOptioneel / item | — |
apiKey.created_by_delegated_grant_id | string | nullOptioneel / item | — |
apiKey.created_by_delegated_grant_idanyOf 1 | stringOptioneel / item |
|
apiKey.created_by_delegated_grant_idanyOf 2 | nullOptioneel / item | — |
idempotent | booleanVerplicht in bovenliggend object | — |
Volledig JSON Schema
{
"type": "object",
"properties": {
"apiKey": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"last_4": {
"type": "string"
},
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"created_at": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
"expires_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"last_used_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"revoked_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$"
},
{
"type": "null"
}
]
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
},
"replaces": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"last_4": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
}
},
"required": [
"id",
"name",
"last_4",
"status"
],
"additionalProperties": false
},
{
"type": "null"
}
]
},
"replaced_by": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"name": {
"type": "string"
},
"last_4": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"active",
"expired",
"revoked"
]
}
},
"required": [
"id",
"name",
"last_4",
"status"
],
"additionalProperties": false
}
},
"capabilities": {
"type": "array",
"items": {
"type": "string",
"enum": [
"agent:operate",
"agent:publish",
"agent:engage"
]
}
},
"workspace_ids": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
},
{
"type": "null"
}
]
},
"created_by_delegated_grant_id": {
"anyOf": [
{
"type": "string",
"format": "uuid"
},
{
"type": "null"
}
]
}
},
"required": [
"id",
"name",
"last_4",
"scopes",
"created_at",
"expires_at",
"last_used_at",
"revoked_at",
"status",
"replaces",
"replaced_by"
],
"additionalProperties": false
},
"idempotent": {
"type": "boolean"
}
},
"required": [
"apiKey",
"idempotent"
],
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false
}Voorbeeld van een toolaanroep
Deze voorbeelden gebruiken fictieve waarden die tegen de schema's zijn gecontroleerd. Vervang IDs door toegestane IDs, media door gereedstaande bestanden en datums door je bevestigde publicatietijd. Controleer accountgeschiktheid vóór een schrijfhandeling. Deze pagina verstuurt geen API-verzoeken.
{
"name": "sosoapi_extend_api_key",
"arguments": {
"id": "11111111-1111-4111-8111-111111111111",
"expires_at": "2099-01-15T09:00:00Z"
}
}structuredContent
{
"apiKey": {
"id": "11111111-1111-4111-8111-111111111111",
"name": "example",
"last_4": "example",
"scopes": [],
"created_at": "2099-01-15T09:00:00Z",
"expires_at": null,
"last_used_at": null,
"revoked_at": null,
"status": "active",
"replaces": null,
"replaced_by": []
},
"idempotent": false
}