createUser
Catégorie | Modification des métadonnées |
Description | Créez un ou plusieurs utilisateurs. Si elle réussit, l'API renverra un message pour l'utilisateur qui vient d'être créé. Prend en charge la création de 1 000 utilisateurs maximum dans une seule demande. |
Autorisations requises pour appeler | Autorisation Utilisateur |
Paramètres obligatoires à la demande | Identifiants |
La demande de ce mode contient un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. L'utilisateur doit avoir l'autorisation "Utilisateur" pour créer le ou les utilisateurs.
Cette méthode ne fonctionne pas après la synchronisation utilisateur depuis Workday.
Format de demande
<?xml version='1.0' encoding='UTF-8'?> <call method="createUser" callerName="a string that identifies your client application"> <credentials login="sampleuser@company.com" password="my_pwd" /> <users> <user email="newUser@company.com" name="new guy" password="new Password" alternateEmail="abc@greenco.com" samlFedId= "1234" permissionSetId="1" ownedLevels="2,3,7,11" timeZone="America/Mexico_City" /> </users> </call>
élément identifiants | |||
Nom du marqueur | identifiants | ||
Description | Tous les appels d'API doivent contenir un seul élément identifiants pour identifier l'utilisateur qui a appelé l'API. L'appel d'API est ensuite effectué en tant qu'utilisateur ( n'importe quelle piste d'audit ou historique d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action afin que l'appel d'API s'appelle réussir. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
se connecter | O | Le nom de connexion de l'utilisateur appelant la méthode API. Cet utilisateur doit avoir les autorisations requises pour appeler la méthode | sampleuser@company.com |
mot de passe | O | Mot de passe de l'utilisateur appelant la méthode API. | my_password |
paramètres régionaux | N | Indiquez les paramètres régionaux à utiliser pour interpréter les chiffres et les dates entrants, et pour formater les chiffres et les dates sortants (en utilisant le séparateur des milliers, les noms de mois et la mise en forme de date appropriés). Les paramètres régionaux sont également utilisés pour indiquer la langue dans laquelle doivent s'afficher les messages système figurant dans la réponse. Si aucune option n'est indiquée, l'expression en_US (anglais américain) est utilisée. | fr_FR |
instanceCode | N | Si l'utilisateur spécifié dans les identifiants a accès à plusieurs instances de : Adaptive Planning , cet attribut peut être utilisé pour indiquer que l'utilisateur a l'intention d'accéder à une instance autre que son instance par défaut. Si aucune option n'est indiquée, l'instance par défaut de l'utilisateur sera utilisée. Pour déterminer les codes d'instance disponibles, utilisez l'API exportInstances. | MYINSTANCE1 |
Contenu de l'élément | |||
(aucun) | |||
élément users | |||
Nom du marqueur | utilisateur(s) | ||
Description | Contient un ou plusieurs éléments utilisateur. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
Contenu de l'élément | |||
Contient un ou plusieurs éléments utilisateur. Prend en charge la création de 1 000 utilisateurs maximum dans une seule demande. | |||
élément utilisateur | |||
Nom du marqueur | utilisateur | ||
Description | Indique un utilisateur ou des utilisateurs à créer. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
e-mail | O | L'adresse e-mail de cet utilisateur. Le caractère unique est obligatoire. Les seuls caractères autorisés sont az, z, 0-9, - et . | newUser@company.com |
nom | O | Le nom de cet utilisateur. | Mel comptes d'action |
position
Disponible dans API v39 et supérieure | N | Poste de l'utilisateur. | "CEO" |
mot de passe | O | Le mot de passe de cet utilisateur. Cet attribut est obligatoire, sauf dans le cas d'une instance connectée à Workday dont la synchronisation utilisateur est activée et qui utilise l'authentification unique SAML Workday pour se connecter à Adaptive Planning. | nouveau mot de passe |
alternateEmail Disponible dans API v27 et API v27 | N | L'autre adresse e-mail de cet utilisateur. Nous sélectionnons automatiquement cette option et renseignons l'e-mail d'identification de l'utilisateur dans la section Détails sur l'utilisateur. | abc@greenco.com |
samlFedId Disponible dans API v27 et API v27 | N | L'identifiant SAML Federation de cet utilisateur. | 1234, user@company.com |
permissionSetId Disponible dans API v25 et supérieure | N | Identifiant système interne de l'ensemble d'autorisations attribué à cet utilisateur. | 3 |
roleId Disponible dans API v25 et antérieures Non disponible dans API v25 et supérieure | N | Identifiant système interne du rôle affecté à cet utilisateur. Il n'existe pas de valeur par défaut. (L'attribut roleId est également traité dans l'API exportRoles.) | 3 |
gestion des périmètres | N | Identifiant du système interne pour les périmètres séparés par des virgules. Il n'existe pas de valeur par défaut. (L'attribut ownerLevels est également couvert dans l'API exportLevels.) | 5,10,13 |
page d'accueil
Disponible dans API v39 et supérieure | N | Page d'accueil de l'utilisateur. | "Welcome" |
timeZone | N | Fuseau horaire de l'utilisateur. Si aucune option n'est spécifiée, la valeur par défaut est US/Tfic. | États-Unis/Pacifique |
pays
Disponible dans API v39 et supérieure | N | Code pays de l'utilisateur (code alpha-2). | "US" |
userState
Disponible dans API v39 et supérieure | N | Code d'État de l'utilisateur (le pays doit être les États-Unis). | "CA" |
netsuiteLogin
Disponible dans API v39 et supérieure | N | Connexion NetSuite. | "abc@netsuite.com" |
salesforceLogin
Disponible dans API v39 et supérieure | N | Connexion Salesforce. | "abc@salesforce.com" |
Contenu de l'élément | |||
(aucun) | |||
Format de la réponse
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <result> <created_users> <user success="true" message="user newUser@company.com was created successfully." guid="0CCF69803A990160E063820012ACFDD7"/> </created_users> </result> </output> </response>
élément de réponse | |||
Nom du marqueur | réponse | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
réussite | O | Vrai ou faux, indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse. | vrai |
Contenu de l'élément | |||
Un seul élément de résultat avec des éléments de statut Created_User ou Updated_User selon qu'un appel createUser ou updateUser a été lancé, respectivement. | |||
élément de résultat | |||
Nom du marqueur | résultat | ||
Description | Conteneur pour un ou plusieurs éléments de statut. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
(aucun) | |||
Contenu de l'élément | |||
Un ou plusieurs éléments de statut create_user ou update_user selon qu'un appel createUser ou updateUser a été passé respectivement. | |||
élément Created_users | |||
Nom du marqueur | Created_users | ||
Description | Représente un message renvoyé par le système à l'appelant. | ||
Attributs de l'élément | |||
Nom de l'attribut | Obligatoire ? | Valeur | Exemple |
réussite de l'utilisateur | O | Statut renvoyé par l'appel. Peut être vraie ou fausse. | vrai |
message | O | Le message de statut. | utilisateurnewuser@company.com a été créé avec succès. |
guide | O | GUID de l'utilisateur créé. | "0CCF69803A990160E063820012ACFDD7" |
Contenu de l'élément | |||
Un élément abonnements. | |||