Gruppen für einen Benutzer auflisten
GET /accounts/{account_id}/core/v1/users/{user_id}/groups
Gibt ein JSON-Array aller übereinstimmenden Ressourcen in der Sammlung zurück. Wenn in der Anfrage einzelne Felder angegeben werden, enthält das JSON-Array die angeforderten Felder für jede übereinstimmende Ressource in der angegebenen Reihenfolge.
Parameter
| Name | Typ | In | Erforderlich | Beschreibung |
|---|---|---|---|---|
Konto-ID |
Zeichenkette |
Pfad |
True |
ID der übergeordneten Kontoressource
|
Benutzer-ID |
Zeichenkette |
Pfad |
True |
ID der übergeordneten Benutzerressource |
Einschließlich |
Zeichenkette |
Abfrage |
Falsch |
Gibt an, welche Felder beim Auflisten einer Sammlung zurückgegeben werden sollen. URL-Beispiele: "include=id", "include=id,name" OpenAPI-Beispiele: "id"
|
Grenze |
Zeichenkette |
Abfrage |
Falsch |
Gibt die maximale Anzahl der Ressourcen an, die beim Auflisten einer Sammlung zurückgegeben werden sollen. URL-Beispiele: "limit=2" OpenAPI-Beispiele: "2" |
Filtern |
Zeichenkette |
Abfrage |
Falsch |
Gibt an, welche Felder übereinstimmen müssen, um beim Auflisten einer Sammlung eine Ressource zurückzugeben. Unterstützte Operatoren sind:
URL-Beispiel: "filter=field%20eq%20%27value%27" OpenAPI-Beispiele: "field eq 'value'" |
Orderby |
Zeichenkette |
Abfrage |
Falsch |
Gibt die Sortierreihenfolge der Ressourcen beim Auflisten einer Sammlung an. URL-Beispiele: "orderBy=name", "orderBy=name%20desc" OpenAPI-Beispiele: "name desc" |
überspringen |
Zeichenkette |
Abfrage |
Falsch |
Gibt die Anzahl der Ressourcen an, die beim Auflisten einer Sammlung übersprungen werden sollen. URL-Beispiele: "skip=1" OpenAPI-Beispiele: "1" |
Zählen |
Zeichenkette |
Abfrage |
Falsch |
Gibt an, ob die Gesamtzahl der Ressourcen im Metadatenobjekt zurückgegeben werden soll. URL-Beispiele: "count=true" OpenAPI-Beispiele: "true" |
fortfahren |
Abfrage |
Falsch |
Gibt das Token an, von dem aus die Auflistung fortgesetzt werden soll. URL-Beispiele: "continue= OpenAPI-Beispiele: " |
Antwort
Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Elemente |
array[Beliebig aus: "group_1.0_get_response_body", array[]] |
True |
|
Metadaten |
True |
Beispielantwort
{
"type": "application/astra-groups",
"version": "1.0",
"items": [
[
"11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa",
"ldap",
"CN=Testers,CN=groups,DC=example,DC=com"
],
[
"e324ec3a-706d-4f57-a95d-1d88c03e7b73",
"ldap",
"CN=Admins,CN=groups,DC=example,DC=com"
],
[
"3070c84d-129b-4017-82a8-2c26a42dd77e",
"ldap",
"CN=SREs,CN=groups,DC=example,DC=com"
]
],
"metadata": {
"labels": [],
"creationTimestamp": "2022-10-06T20:58:16.305662Z",
"modificationTimestamp": "2022-10-06T20:58:16.305662Z",
"createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
}
}
Antwort
Status: 400, Bad request
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
|
invalidParams |
Array["invalidParams"] |
Falsch |
Liste ungültiger Abfrageparameter |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Antwort
Status: 500, Internal server error
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispielantwort
{
"type": "https://astra.netapp.io/problems/34",
"title": "Internal server error",
"detail": "The server was unable to process this request.",
"status": "500"
}
Fehler
Status: 404, Not found
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
|
Titel |
Zeichenkette |
True |
|
Detail |
Zeichenkette |
True |
|
Status |
Zeichenkette |
True |
|
Korrelations-ID |
Zeichenkette |
Falsch |
Beispiel-Fehlermeldung
{
"type": "https://astra.netapp.io/problems/1",
"title": "Resource not found",
"detail": "The resource specified in the request URI wasn't found.",
"status": "404"
}
Definitionen
Siehe Definitionen
Typ_Astra_Label
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Name |
Zeichenkette |
True |
|
Wert |
Zeichenkette |
True |
type_astra_metadata_update
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:
-
Entspricht dem Astra-Metadatenschema. Falls beim Erstellen keine Bezeichnung angegeben wird, wird ein Metadatenobjekt ohne Bezeichnungen 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 |
group_1.0_get_response_body
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
Typ |
Zeichenkette |
True |
Medientyp der Ressource. Folgende Werte sind definiert:
|
Version |
Zeichenkette |
True |
Version der Ressource. Folgende Werte sind definiert:
|
id |
Zeichenkette |
True |
Weltweit eindeutiger Bezeichner der Ressource. Folgende Werte sind definiert:
|
Name |
Zeichenkette |
True |
Der Name der Gruppenressource. Falls beim Erstellen nicht angegeben, wird der Wert auf
|
authProvider |
Zeichenkette |
True |
Der Authentifizierungsanbieter für die Gruppenressource. Folgende Werte sind definiert:
|
authID |
Zeichenkette |
True |
Der Distinguished Name (DN) einer LDAP-Gruppe. Folgende Werte sind definiert:
|
Metadaten |
True |
Client- und dienstspezifische Metadaten, die der Ressource zugeordnet sind. Folgende Werte sind definiert:
|
type_astra_metadata_list
| Name | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
fortfahren |
Zeichenkette |
Falsch |
|
Zählen |
Nummer |
Falsch |
|
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 |
True |
Name des ungültigen Abfrageparameters |
Grund |
Zeichenkette |
True |
Grund, warum der Abfrageparameter ungültig ist |