Neue Anmeldeinformationen erstellen
POST /accounts/{account_id}/core/v1/credentials
Gibt die gewünschten Werte für die zu erstellende Credential-API-Ressource an.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
Wahr |
ID der übergeordneten Kontoressource
|
Anfragetext
Gibt die gewünschten Werte für die zu erstellende Credential-API-Ressource an.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
Wahr |
Version der Ressource. Definierte Werte sind:
|
Name |
Zeichenkette |
Wahr |
JSON-Zeichenfolge mit einem benutzerdefinierten Namen. Beim Erstellen von Anmeldeinformationen für einen Benutzer wird der Name auf die UUID dieses Benutzers gesetzt. Folgende Werte sind definiert:
|
keyType |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem optionalen, vom Benutzer festgelegten Datenvalidierungstypdeskriptor für den Inhalt der keyStore. Erweiterte Aktualisierungseinschränkungen:
|
keyStore |
Wahr |
JSON-Objekt mit JSON-Zeichenketten. Jede Zeichenkette in keyStore repräsentiert einen Teil der Anmeldeinformationen. Der Name jeder Zeichenkette steht für den entsprechenden Teil der Anmeldeinformationen, und der zugehörige Schlüssel-Wert speichert den Wert dieses Teils im Base64-Format. Folgende Werte sind definiert:
|
|
Gültig |
Zeichenkette |
Falsch |
JSON-Zeichenkette, die beschreibt, ob die Anmeldeinformationen gültig sind. Standardwert, wenn weggelassen, ist „true“. Folgende Werte sind definiert:
|
validFromTimestamp |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Zeitstempel, der angibt, wann die Anmeldeinformationen gültig sind. Diese werden für die Rotation der Anmeldeinformationen verwendet. Definierte Werte sind:
|
validUntilTimestamp |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Zeitstempel, der angibt, wann die Anmeldeinformationen nicht mehr gültig sind. Diese werden für die Rotation der Anmeldeinformationen verwendet. Definierte Werte sind:
|
Metadaten |
Falsch |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielanfrage
{
"type": "application/astra-credential",
"version": "1.1",
"name": "myCert",
"keyStore": {
"privKey": "SGkh",
"pubKey": "VGhpcyBpcyBhbiBleGFtcGxlLg=="
}
}
Antwort
Status: 201, Returns the newly created credential resource in the JSON response body.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
Medientyp der Ressource. Definierte Werte sind:
|
Version |
Zeichenkette |
Wahr |
Version der Ressource. Definierte Werte sind:
|
id |
Zeichenkette |
Wahr |
Weltweit eindeutiger Bezeichner der Ressource. Definierte Werte sind:
|
Name |
Zeichenkette |
Wahr |
JSON-Zeichenfolge mit einem benutzerdefinierten Namen. Beim Erstellen von Anmeldeinformationen für einen Benutzer wird der Name auf die UUID dieses Benutzers gesetzt. Folgende Werte sind definiert:
|
keyType |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem optionalen, vom Benutzer festgelegten Datenvalidierungstypdeskriptor für den Inhalt der keyStore. Erweiterte Aktualisierungseinschränkungen:
|
Gültig |
Zeichenkette |
Wahr |
JSON-Zeichenkette, die beschreibt, ob die Anmeldeinformationen gültig sind. Standardwert, wenn weggelassen, ist „true“. Folgende Werte sind definiert:
|
validFromTimestamp |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Zeitstempel, der angibt, wann die Anmeldeinformationen gültig sind. Diese werden für die Rotation der Anmeldeinformationen verwendet. Definierte Werte sind:
|
validUntilTimestamp |
Zeichenkette |
Falsch |
JSON-Zeichenkette mit einem Zeitstempel, der angibt, wann die Anmeldeinformationen nicht mehr gültig sind. Diese werden für die Rotation der Anmeldeinformationen verwendet. Definierte Werte sind:
|
Metadaten |
Wahr |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
|
Beispielantwort
{
"type": "application/astra-credential",
"version": "1.1",
"id": "58e26f6a-a631-5122-8e0e-7afe306675c0",
"name": "myCert",
"valid": "true",
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Antwort
Status: 401, Unauthorized
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Antwort
Status: 400, Bad request
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
|
invalidFields |
Array["invalidFields"] |
Falsch |
Liste ungültiger Anfragetextfelder |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Antwort
Status: 409, Conflict
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
|
invalidFields |
Array["invalidFields"] |
Falsch |
Liste ungültiger Anfragetextfelder |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/10",
"title": "JSON resource conflict",
"detail": "The request body JSON contains a field that conflicts with an idempotent value.",
"status": "409"
}
Antwort
Status: 403, Forbidden
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Fehler
Status: 404, Not found
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
Wahr |
|
Titel |
Zeichenkette |
Wahr |
|
Detail |
Zeichenkette |
Wahr |
|
Status |
Zeichenkette |
Wahr |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispiel-Fehlermeldung
{
"type": "https://astra.netapp.io/problems/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
Definitionen
Siehe Definitionen
keyStore
JSON-Objekt mit JSON-Zeichenketten. Jede Zeichenkette in keyStore repräsentiert einen Teil der Anmeldeinformationen. Der Name jeder Zeichenkette steht für den entsprechenden Teil der Anmeldeinformationen, und der zugehörige Schlüssel-Wert speichert den Wert dieses Teils im Base64-Format. Folgende Werte sind definiert:
-
Entspricht dem Base64-kodierten Datenschema. Es gibt keine Beschränkungen hinsichtlich der Länge der Zeichenketten.
Hash-Zuordnung von Zeichenketten zu Zeichenketten
Typ_Astra_Label
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
|
Wert |
Zeichenkette |
Wahr |
type_astra_metadata_update
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Definierte Werte sind:
-
Entspricht dem Astra-Metadatenschema. Wird beim Erstellen kein Label angegeben, wird ein Metadatenobjekt ohne Labels erstellt. Wird beim Aktualisieren kein Label angegeben, bleiben die Labels, creationTimestamp und createdBy, des Metadatenobjekts unverändert erhalten.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Etiketten |
Array["Typ_Astra_Label"] |
Falsch |
|
CreationZeitstempel |
Zeichenkette |
Falsch |
|
Änderungszeitstempel |
Zeichenkette |
Falsch |
|
Erstellt von |
Zeichenkette |
Falsch |
|
modifiedBy |
Zeichenkette |
Falsch |
invalidParams
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
Wahr |
Grund, warum der Abfrageparameter ungültig ist |
invalidFields
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
Wahr |
Name des ungültigen Anfragetextfelds |
Grund |
Zeichenkette |
Wahr |
Grund, warum das Anfragekörperfeld ungültig ist |