Auth Key bearbeiten
Aktualisiert bei einem Auth Key die Beschreibung, die Scopes oder den Aktivierungsstatus.
https://api2.transloadit.com/ auth_keys/ {authKeyId}Ein Schlüssel für Smart CDN kann keine gewöhnlichen API-Anfragen authentifizieren und keine Bearer-Tokens ausstellen. Erstellen Sie einen separaten Schlüssel für Smart CDN; wenn Sie Smart CDN für einen Integrationsschlüssel aktivieren, kann dieser Schlüssel keine API-Anfragen mehr authentifizieren.
Anfragebeispiel
Setzen Sie AUTH_KEY_ID auf den Wert Ihrer Ressource, ohne ihn mit Prozentkodierung zu versehen.
Führen Sie diese Anfrage in einer serverseitigen Shell mit curl und einem geeigneten Bearer-Token in TRANSLOADIT_TOKEN aus. Wenn Sie ein Token benötigen, klappen Sie die folgende Einrichtungsanleitung auf.
Benötigen Sie ein Bearer-Token?
Setzen Sie in einer vertrauenswürdigen serverseitigen Shell mit curl und jq TRANSLOADIT_KEY auf Ihren Auth Key und TRANSLOADIT_SECRET auf Ihr Auth Secret. Halten Sie beide Zugangsdaten und das resultierende Token geheim; führen Sie diese Einrichtung niemals im Browsercode aus.
Erstellen Sie zunächst ein Token mit den für diesen Endpunkt erforderlichen Scopes. Ihr Auth Key muss diese Scopes bereits gewähren.
if ! TOKEN_RESPONSE="$(curl --fail-with-body -sS \
--request POST \
--url 'https://api2.transloadit.com/token' \
--user "${TRANSLOADIT_KEY:?Set TRANSLOADIT_KEY}:${TRANSLOADIT_SECRET:?Set TRANSLOADIT_SECRET}" \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials' \
--data-urlencode 'aud=api2' \
--data-urlencode 'scope=auth_keys:write')"; then
printf '%s\n' "$TOKEN_RESPONSE" >&2
exit 1
fi
TRANSLOADIT_TOKEN="$(printf '%s' "$TOKEN_RESPONSE" |
jq -er '.access_token | strings | select(length > 0)')" || exit 1
Lassen Sie diese Shell geöffnet und führen Sie die untenstehende Anfrage aus. Verwenden Sie das Token erneut, solange es gültig bleibt.
curl --fail-with-body -sS --request PUT \
--url "https://api2.transloadit.com/auth_keys/${AUTH_KEY_ID:?Set AUTH_KEY_ID}" \
--header "Authorization: Bearer ${TRANSLOADIT_TOKEN:?Set TRANSLOADIT_TOKEN}" \
--data-urlencode 'params={"description":"Updated backend integration"}'
Authentifizierung
Dieser Endpunkt akzeptiert signierte params oder ein Bearer-Token. Anweisungen zur Einrichtung finden Sie unter Authentifizierung.
Erforderlicher Berechtigungsumfang für Auth Key oder Bearer-Token: auth_keys:write.
Signierte Anfragen erfordern sowohl eine signature als auch einen in der Zukunft liegenden Zeitstempel für params.auth.expires. Bearer-Tokens erfordern keines von beiden.
Pfadparameter
authKeyId(Pfadsegment), erforderlich. Muster:^[0-9a-f]{32}$, minimale Länge: 32, maximale Länge: 32
Formularfelder
Content-Type: application/x-www-form-urlencoded
params(JSON-Zeichenfolge), erforderlich. Ein JSON-codiertes Objekt, dessen unterstützte Schlüssel unten aufgeführt sind.signature(Zeichenfolge). Für signierte Anfragen erforderlich. Lassen Sie dieses Feld weg, wenn Sie ein Bearer-Token verwenden.
Unterstützte Schlüssel im Feld params
Die Authentifizierungsfelder in dieser Liste gelten für signierte Anfragen. Mit einem Bearer-Token können Sie params.auth und das separate Feld signature weglassen. Vergleichen Sie unten die Anfrageparameter der einzelnen Authentifizierungsmethoden.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
| Feld | Typ und Beschreibung |
|---|---|
params.für signierte Anfragen erforderlich; mit einem Bearer-Token optional | Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication einer Auth-Keys-Anfrage.
|
params.erforderlich | stringISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen. |
params.erforderlich | stringTransloadit API-Schlüssel zur Authentifizierung von Anfragen |
params. | string | integerEindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann. |
params. | string (maximale Länge: 255)Menschenlesbare Beschreibung des Auth Key. Zeichen außerhalb der Basic Multilingual Plane von Unicode, darunter die meisten Emojis, werden nicht unterstützt. Validierungsmuster (regulärer Ausdruck)^[\u0000-\ud7ff\ue000-\uffff]*$ |
params. | boolean | 0 | 1Gibt an, ob dieser Auth Key aktiv ist. |
params. | boolean | 0 | 1Ob dieser Auth Key ausschließlich für Smart CDN-URLs bestimmt ist. Ein Smart CDN-Schlüssel kann weder gewöhnliche API-Anfragen authentifizieren noch Bearer-Tokens ausstellen. Verwenden Sie für Smart CDN einen separaten Schlüssel. Beim Erstellen gilt bei Weglassen false als Standardwert. Beim Aktualisieren bleibt der aktuelle Wert erhalten, wenn das Feld weggelassen wird; senden Sie ausdrücklich false, um die Smart CDN-Nutzung zu deaktivieren. |
params. | string | integerEindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann. |
params. | stringDurch Kommas getrennte Scopes des Auth Keys. API2 normalisiert doppelte Scopes. Validierungsmuster (regulärer Ausdruck)^(?:[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*,)*[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*(?:read|write|auth_keys:write|auth_keys:read|assemblies:write|assemblies:read|assembly_notifications:write|dam:write|template_credentials:read|template_credentials:write|billing:read|queues:read|templates:read|templates:write|storage_grants:write)[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*(?:,[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*(?:(?:read|write|auth_keys:write|auth_keys:read|assemblies:write|assemblies:read|assembly_notifications:write|dam:write|template_credentials:read|template_credentials:write|billing:read|queues:read|templates:read|templates:write|storage_grants:write)[\x09-\x0D\x20\xA0\u1680\u2000\u2001\u2002\u2003\u2004\u2005\u2006\u2007\u2008\u2009\u200a\u2028\u2029\u202f\u205f\u3000\ufeff]*)?)*$ |
params. | "sha1" | "sha256" | "sha384" | nullHMAC-Algorithmus zum Signieren von Anfragen mit diesem Auth Key. Bei der Erstellung verwenden gewöhnliche API-Schlüssel standardmäßig |
Anfrageparameter nach Authentifizierungsmethode
Mit signierten Parametern
Geben Sie Ihren Auth Key als params.auth.key an. Wenn Sie die Anfrage signieren, geben Sie einen in der Zukunft liegenden Zeitstempel für params.auth.expires an und senden Sie die Signature im separaten Feld signature. Die folgenden Felddefinitionen verwenden Pfade innerhalb von params.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
Verwendet die oben angegebenen Felddefinitionen: params.auth, params.description, params.is_active, params.is_allowed_for_smartcdn, params.nonce, params.scope, params.signature_algo
Mit einem Bearer-Token
Senden Sie das Bearer-Token im Authorization-Header. Sie können params.auth und das separate Feld signature weglassen. Die übrigen erforderlichen Parameter müssen weiterhin angegeben werden. Die folgenden Felddefinitionen verwenden Pfade innerhalb von params.
Vollständiges JSON Schema
params: Es werden nur die für dieses Objekt aufgeführten Felder akzeptiert.
Verwendet die oben angegebenen Felddefinitionen: params.description, params.is_active, params.is_allowed_for_smartcdn, params.nonce, params.scope, params.signature_algo
| Feld | Typ und Beschreibung |
|---|---|
params. | Enthält den Transloadit-API-Schlüssel und Metadaten für die Signature Authentication einer Auth-Keys-Anfrage.
|
params. | stringISO-8601-Ablaufzeitstempel in der Zukunft. Erforderlich, wenn eine Anfrage signiert ist oder Signaturauthentifizierung erfordert; mit Bearer authentifizierte Anfragen können ihn weglassen. |
params. | stringTransloadit API-Schlüssel zur Authentifizierung von Anfragen |
params. | string | integerEindeutiger Zufallswert, der in die Parameter signierter Anfragen aufgenommen wird, damit jede Signatur eindeutig ist und nicht versehentlich wiederverwendet werden kann. |
Antwort
2xx-Erfolg
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Die Antwort kann zusätzliche Felder enthalten.
| Feld | Typ und Beschreibung |
|---|---|
auth_keyerforderlich |
|
auth_key.erforderlich | string | null (maximale Länge: 64)Validierungsmuster (regulärer Ausdruck)^[\u0000-\ud7ff\ue000-\uffff]*$ |
auth_key.erforderlich | boolean |
auth_key.erforderlich | string | nullZeitpunkt der Erstellung des Auth Keys als ISO-8601-Zeitstempel oder null, wenn kein Erstellungszeitpunkt erfasst wurde. Validierungsmuster (regulärer Ausdruck)^(([0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|1[0-9]|2[0-8])))T([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9](\.[0-9]+)?)?(Z)$ |
auth_key.erforderlich | string (maximale Länge: 255)Validierungsmuster (regulärer Ausdruck)^[\u0000-\ud7ff\ue000-\uffff]*$ |
auth_key.erforderlich | string |
auth_key.erforderlich | boolean |
auth_key.erforderlich | boolean |
auth_key.erforderlich | string | nullUngefährer Zeitpunkt der letzten Verwendung als ISO-8601-Zeitstempel oder null, wenn kein Zeitstempel erfasst wurde. Die Nutzung wird asynchron erfasst und stapelweise gespeichert, daher kann dieser Wert hinter den Anfragen zurückliegen. Dies ist kein exakter Audit-Zeitstempel, und null beweist nicht, dass der Schlüssel nie verwendet wurde. Validierungsmuster (regulärer Ausdruck)^(([0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|1[0-9]|2[0-8])))T([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9](\.[0-9]+)?)?(Z)$ |
auth_key.erforderlich | string | nullZeitpunkt der letzten Aktualisierung der Auth-Key-Einstellungen als ISO-8601-Zeitstempel oder null, wenn kein Änderungszeitpunkt erfasst wurde. Die Nutzung wird separat in Validierungsmuster (regulärer Ausdruck)^(([0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-((0[13578]|1[02])-(0[1-9]|[12][0-9]|3[01])|(0[469]|11)-(0[1-9]|[12][0-9]|30)|(02)-(0[1-9]|1[0-9]|2[0-8])))T([01][0-9]|2[0-3]):[0-5][0-9](:[0-5][0-9](\.[0-9]+)?)?(Z)$ |
auth_key.erforderlich | string | null (maximale Länge: 255)Validierungsmuster (regulärer Ausdruck)^[\u0000-\ud7ff\ue000-\uffff]*$ |
auth_key.erforderlich | null | string |
messageerforderlich | string (minimale Länge: 1) |
okerforderlich | string (immer: "AUTH_KEY_UPDATED") |
Fehlerantwort
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Die Antwort kann zusätzliche Felder enthalten.
| Feld | Typ und Beschreibung |
|---|---|
assembly_id | string |
error | string (minimale Länge: 1) |
http_code | number | string
|
message | stringMenschenlesbare Erklärung des Fehlers. Die Formulierung kann variieren; verwenden Sie den Code |
reason | null | string | number | boolean | Array<beliebiger Wert> | objectEines der folgenden Schemas kann gelten: nullnullstringstringnumbernumberbooleanbooleanArray<beliebiger Wert>Array<beliebiger Wert>Schema eines Array-Elementsbeliebiger WertobjectobjectSchema für zusätzliche Eigenschaftenbeliebiger Wert |
HTTP 400
JSON-Response-Body. application/json text/plain; charset=utf-8
Schema des Response-Bodys
Vollständiges JSON Schema
Benannte Fehler und das allgemeine Fehlerformat
error: "AUTH_KEY_NOT_UPDATED"
Ihr Auth Key konnte nicht aktualisiert werden.
Die Antwort kann zusätzliche Felder enthalten.