Modifier un utilisateur pour un groupe
PUT /accounts/{account_id}/core/v1/groups/{group_id}/users/{user_id}
Remplace l'intégralité de la ressource stockée par le corps de la requête JSON fourni, tout en préservant les valeurs clés non modifiables par l'utilisateur.
Paramètres
| Nom | Type | Dans | Obligatoire | Description |
|---|---|---|---|---|
identifiant_compte |
chaîne |
chemin |
Vrai |
ID de la ressource de compte conteneur
|
group_id |
chaîne |
chemin |
Vrai |
ID de la ressource de groupe conteneur |
ID de l'utilisateur |
chaîne |
chemin |
Vrai |
ID de la collection utilisateur à lister |
Corps de la requête
Remplace l'intégralité de la ressource stockée par le corps de la requête JSON fourni, tout en préservant les valeurs clés non modifiables par l'utilisateur.
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
type |
chaîne |
Vrai |
Type de média de la ressource. Les valeurs définies sont :
|
version |
chaîne |
Vrai |
Version de la ressource. Les valeurs définies sont :
|
id |
chaîne |
Faux |
Identifiant unique global de la ressource. Les valeurs définies sont :
|
État |
chaîne |
Faux |
Chaîne JSON contenant une valeur indiquant l'état opérationnel de l'utilisateur. Les valeurs définies sont :
|
isEnabled |
chaîne |
Faux |
Chaîne JSON indiquant si l'utilisateur est autorisé à se connecter. Les valeurs possibles sont :
|
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 :
|
firstName |
chaîne |
Faux |
Chaîne JSON contenant un prénom long spécifié par l'utilisateur. Les valeurs définies sont :
|
lastName |
chaîne |
Faux |
Chaîne JSON contenant un nom de famille long spécifié par l'utilisateur. Les valeurs définies sont :
|
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. Valeurs définies :
|
chaîne |
Faux |
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 |
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 |
Faux |
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 possibles sont :
|
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 :
|
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.) Valeurs définies :
|
les métadonnées |
Faux |
Métadonnées spécifiques au client et au service associées à la ressource. Les valeurs définies sont :
|
Exemple de requête
{
"type": "application/astra-user",
"version": "1.2",
"firstName": "John",
"lastName": "Dale",
"email": "jdale@example.com"
}
Réponse
Status: 204, Indicates if the user resource was updated.
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 |
|
invalidFields |
tableau["invalidFields"] |
Faux |
Liste des champs invalides du corps de la requête |
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: 409, Conflict
| 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 |
|
invalidFields |
tableau["invalidFields"] |
Faux |
Liste des champs invalides du corps de la requête |
Exemple de réponse
{
"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"
}
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/1",
"title": "Resource not found",
"detail": "The resource 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 :
|
addressLocality |
chaîne |
Vrai |
Chaîne JSON contenant la localité (par exemple, la ville) associée à l'adresse postale. Les valeurs définies sont :
|
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 :
|
postalCode |
chaîne |
Vrai |
Chaîne JSON contenant le code postal associé à l'adresse postale. Les valeurs définies sont :
|
streetAddress1 |
chaîne |
Vrai |
Chaîne JSON contenant l'adresse de rue associée à l'adresse postale. Les valeurs définies sont :
|
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 :
|
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 |
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 |
invalidFields
| Nom | Type | Obligatoire | Description |
|---|---|---|---|
nom |
chaîne |
Vrai |
Nom du champ invalide du corps de la requête |
raison |
chaîne |
Vrai |
Raison pour laquelle le champ du corps de la requête est invalide |