Skip to main content
Astra Automation
Une version plus récente de ce produit est disponible.
La version française est une traduction automatique. La version anglaise prévaut sur la française en cas de divergence.

Liste des utilisateurs d'un groupe

PDF

GET /accounts/{account_id}/core/v1/groups/{group_id}/users

Renvoie un tableau JSON contenant toutes les ressources correspondantes de la collection. Si des champs individuels sont spécifiés dans la requête, le tableau JSON items contiendra les champs demandés pour chaque ressource correspondante dans l'ordre indiqué.

Paramètres

Nom Type Dans Obligatoire Description

identifiant_compte

chaîne

chemin

Vrai

ID de la ressource de compte conteneur

  • exemple: {{.Account}}

group_id

chaîne

chemin

Vrai

ID de la ressource de groupe conteneur

inclure

chaîne

requête

Faux

Indique les champs qui doivent être renvoyés lors de l’énumération d’une collection.

Exemples d'URL : « include=id », « include=id,name »

Exemples OpenAPI : « id »

  • Exemple : id,email

limite

chaîne

requête

Faux

Indique le nombre maximal de ressources à renvoyer lors de l’énumération d’une collection.

Exemples d'URL : « limit=2 »

Exemples OpenAPI : « 2 »

filtre

chaîne

requête

Faux

Indique les champs qui doivent être mis en correspondance pour renvoyer une ressource lors du listage d'une collection.

Les opérateurs pris en charge sont :

  • eq - Égalité

  • lt/gt - Inférieur à/Supérieur à

  • LTE/GTE - Inférieur ou égal à/Supérieur ou égal à

Exemple d'URL : « filter=field%20eq%20%27value%27 »

Exemples OpenAPI : « field eq 'value' »

Orderby

chaîne

requête

Faux

Indique l'ordre de tri des ressources lors de l'affichage d'une collection.

Exemples d'URL : « orderBy=name », « orderBy=name%20desc »

Exemples OpenAPI : « name desc »

ignorer

chaîne

requête

Faux

Indique le nombre de ressources à ignorer lors de l'énumération d'une collection.

Exemples d'URL : « skip=1 »

Exemples OpenAPI : « 1 »

nombre

chaîne

requête

Faux

Indique si le nombre total de ressources doit être renvoyé dans l'objet métadonnées.

Exemples d'URL : « count=true »

Exemples OpenAPI : "true"

continuer

requête

Faux

Indique le jeton à partir duquel reprendre la liste.

Exemples d'URL : « continue= »

Exemples OpenAPI : ""</continue>

Réponse

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.
Nom Type Obligatoire Description

articles

tableau[N'importe lequel de : "corps de réponse user_1.2_get_response_body", tableau[]]

Vrai

les métadonnées

"type_astra_metadata_list"

Vrai
Exemple de réponse 
{
  "type": "application/astra-users",
  "version": "1.2",
  "items": [
    [
      "11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa",
      "jdoe@example.com"
    ],
    [
      "e324ec3a-706d-4f57-a95d-1d88c03e7b73",
      "ssmith@example.com"
    ],
    [
      "3070c84d-129b-4017-82a8-2c26a42dd77e",
      "wjohns@example.com"
    ]
  ],
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

Réponse

Status: 401, Unauthorized
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Réponse

Status: 400, Bad request
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux

invalidParams

tableau["invalidParams"]

Faux

Liste des paramètres de requête invalides
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Réponse

Status: 403, Forbidden
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux
Exemple de réponse 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Erreur

Status: 404, Not found
Nom Type Obligatoire Description

type

chaîne

Vrai

titre

chaîne

Vrai

détail

chaîne

Vrai

statut

chaîne

Vrai

identifiant de corrélation

chaîne

Faux
Exemple de réponse d'erreur 
{
  "type": "https://astra.netapp.io/problems/2",
  "title": "Collection not found",
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404"
}

Définitions

Voir les définitions

postalAddress

Objet JSON contenant une collection de champs qui spécifie une adresse. Si cette clé n'existe pas, cela indique qu'aucune adresse n'a été fournie. Si cette clé existe, les six champs qu'elle contient seront tous présents. Si rien n'a été fourni par l'utilisateur, la chaîne sera vide.

Nom Type Obligatoire Description

addressCountry

chaîne

Vrai

Chaîne JSON contenant le nom ou le code pays associé à l'adresse postale, conformément à la norme ISO 3166 Alpha-2. Les valeurs définies sont :

  • Longueur minimale : 2

  • Longueur maximale : 2

addressLocality

chaîne

Vrai

Chaîne JSON contenant la localité (par exemple, la ville) associée à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

addressRegion

chaîne

Vrai

Chaîne JSON contenant la région (par exemple, l'État) associée à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

postalCode

chaîne

Vrai

Chaîne JSON contenant le code postal associé à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

streetAddress1

chaîne

Vrai

Chaîne JSON contenant l'adresse de rue associée à l'adresse postale. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

streetAddress2

chaîne

Faux

Chaîne JSON contenant des informations complémentaires facultatives telles que l'adresse de rue, la boîte postale, etc. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

type_astra_label

Nom Type Obligatoire Description

nom

chaîne

Vrai

valeur

chaîne

Vrai

type_astra_metadata_update

Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :

  • Conforme au schéma de métadonnées Astra. Si aucune étiquette n'est spécifiée lors de la création, un objet de métadonnées sera créé sans étiquette. Si aucune étiquette n'est spécifiée lors de la mise à jour, les étiquettes de l'objet de métadonnées, creationTimestamp et createdBy, seront conservées sans modification.

Nom Type Obligatoire Description

étiquettes

tableau["type_astra_label"]

Faux

CréationTimestamp

chaîne

Faux

ModificationTimestamp

chaîne

Faux

CreatedBy

chaîne

Faux

modifiedBy

chaîne

Faux

corps de réponse user_1.2_get_response_body

Nom Type Obligatoire Description

type

chaîne

Vrai

Type de média de la ressource. Les valeurs définies sont :

  • "application/astra-user"

version

chaîne

Vrai

Version de la ressource. Les valeurs définies sont :

  • "1,0"

  • "1,1"

  • "1,2"

id

chaîne

Vrai

Identifiant unique global de la ressource. Les valeurs définies sont :

  • Conforme au schéma UUIDv4

État

chaîne

Vrai

Chaîne JSON contenant une valeur indiquant l'état opérationnel de l'utilisateur. Les valeurs définies sont :

  • « En attente » - Le compte utilisateur est en cours de création. L'utilisateur peut uniquement lire et modifier la ressource utilisateur (valeur par défaut).

  • Cet état n'est pas valide pour un utilisateur avec « authProvider » défini sur « local »

  • « actif » - Le compte utilisateur est opérationnel (L'utilisateur peut se connecter si le paramètre de compte «isEnabled» est « true »).

  • Il s'agit de la valeur par défaut pour un utilisateur avec « authProvider » défini sur « local »

  • « suspendu » - Le compte utilisateur est suspendu (L'utilisateur ne peut pas se connecter quel que soit le paramètre de compte "isEnabled").

isEnabled

chaîne

Vrai

Chaîne JSON indiquant si l'utilisateur est autorisé à se connecter. Les valeurs possibles sont :

  • « true » - L'utilisateur est autorisé à se connecter ; valeur par défaut lors de la création.

  • "false" - L'utilisateur n'est pas autorisé à se connecter.

authID

chaîne

Faux

Chaîne JSON contenant l'identifiant associé à un fournisseur d'identité externe. Le contenu de cette chaîne dépend du authProvider spécifié. Pour un utilisateur avec « authProvider » défini sur « local », « authID » est défini sur la valeur de « email ». Pour un utilisateur avec « authProvider » défini sur « ldap », « authID » est défini sur son nom distinctif (DN) provenant du serveur LDAP.

authProvider

chaîne

Faux

Chaîne JSON indiquant le contexte de l'idAuth identifiant. Les valeurs définies sont :

  • « cloud-central » - L'authentification des utilisateurs provient du service NetApp Cloud Central

  • « local » - L'authentification de l'utilisateur provient du magasin local d'utilisateur/mot de passe

  • "ldap" - L'authentification utilisateur provient d'un serveur LDAP externe. Dans Astra Control Center, tous les utilisateurs doivent avoir une valeur de "local" ou "ldap". Si une valeur n'est pas spécifiée, une valeur par défaut de "local" est choisie. Dans Astra Control Service, "authProvider" avec "local" ou "ldap" n'est pas pris en charge. Si une valeur n'est pas spécifiée, la valeur par défaut sera "cloud-central".

firstName

chaîne

Vrai

Chaîne JSON contenant un prénom long spécifié par l'utilisateur. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

  • Cette chaîne de caractères est validée en interne afin de prévenir les attaques XSS, Unicode, de traversée de répertoire et d'injection SQL

lastName

chaîne

Vrai

Chaîne JSON contenant un nom de famille long spécifié par l'utilisateur. Les valeurs définies sont :

  • Longueur minimale : 0

  • Longueur maximale : 63

  • Cette chaîne de caractères est validée en interne afin de prévenir les attaques XSS, Unicode, de traversée de répertoire et d'injection SQL

companyName

chaîne

Faux

Chaîne JSON contenant le nom de l'entreprise associée à l'utilisateur. Si cette clé n'existe pas, cela indique qu'un nom d'entreprise n'a pas été fourni. Les valeurs définies sont :

  • Longueur minimale : 1

  • Longueur maximale : 63

  • Cette chaîne de caractères est validée en interne afin de prévenir les attaques XSS, Unicode, de traversée de répertoire et d'injection SQL

e-mail

chaîne

Vrai

Chaînes JSON contenant une adresse électronique spécifiée par l'utilisateur.

téléphone

chaîne

Faux

Chaîne JSON contenant le numéro de téléphone de l'utilisateur. Si cette clé n'existe pas, cela indique qu'un numéro de téléphone n'a pas été fourni.

postalAddress

"postalAddress"

Faux

Objet JSON contenant une collection de champs qui spécifie une adresse. Si cette clé n'existe pas, cela indique qu'aucune adresse n'a été fournie. Si cette clé existe, les six champs qu'elle contient seront tous présents. Si rien n'a été fourni par l'utilisateur, la chaîne sera vide.

sendWelcomeEmail

chaîne

Vrai

Chaîne JSON indiquant si un e-mail de bienvenue sera envoyé après validation. Si cette valeur n'est pas spécifiée lors de la création, elle sera définie sur "true" pour ACS et sur "false" pour Astra Control Center. Les valeurs définies sont :

  • « true » - un e-mail de bienvenue sera envoyé ; valeur par défaut lors de la création

  • "false" - Aucun e-mail de bienvenue ne sera envoyé. Pour un utilisateur avec "authProvider" comme "local" ou "ldap", cette valeur est ignorée et définie sur "false".

enableTimestamp

chaîne

Faux

Chaîne JSON contenant un horodatage au format ISO-8601 indiquant la dernière activation de l'utilisateur. Les valeurs définies sont :

  • Conforme au schéma de date et d'heure ISO-8601

lastActTimestamp

chaîne

Faux

Chaîne JSON contenant un horodatage au format ISO-8601 indiquant la dernière utilisation de l'API d'identité pour le compte de cet utilisateur. (Remarque : cette opération est coûteuse.) Les valeurs définies sont :

  • Conforme au schéma de date et d'heure ISO-8601

les métadonnées

"type_astra_metadata_update"

Vrai

Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :

  • Conforme au schéma de métadonnées Astra. Si aucune étiquette n'est spécifiée lors de la création, un objet de métadonnées sera créé sans étiquette. Si aucune étiquette n'est spécifiée lors de la mise à jour, les étiquettes de l'objet de métadonnées, creationTimestamp et createdBy, seront conservées sans modification.

type_astra_metadata_list

Nom Type Obligatoire Description

continuer

chaîne

Faux

nombre

nombre

Faux

étiquettes

tableau["type_astra_label"]

Faux

CréationTimestamp

chaîne

Faux

ModificationTimestamp

chaîne

Faux

CreatedBy

chaîne

Faux

modifiedBy

chaîne

Faux

invalidParams

Nom Type Obligatoire Description

nom

chaîne

Vrai

Nom du paramètre de requête invalide

raison

chaîne

Vrai

Raison pour laquelle le paramètre de requête est invalide
Close
Try it out

Sign in with your NetApp Cloud Central credentials.

Try this API

Parameters

Headers

Body

Code

Response