Créer un utilisateur

Utilisez l'API Créer un utilisateur pour créer un nouvel utilisateur dans la Control Room.

Demande

POST https://{{ControlRoomURL}}/v1/usermanagement/users

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<bearer token>>

Tous les appels d'API doivent contenir soit un jeton d'authentification de API d'authentification (génère un JSON Web Token), soit un Bearer token des services OAuth. Vous ne pouvez pas utiliser les deux ensemble dans une API.

Corps de la demande :

{
    "roles": [
        {
            "id": 185
        }
    ],
    "email": "aaa@a.com",
    "enableAutoLogin": true,
    "username": "test1",
    "description": "",
    "firstName": "joe",
    "lastName": "doe",
    "disabled": false,
    "password": "aa360aa360",
    "licenseFeatures": [
        "DEVELOPMENT"
    ],
    "sysAssignedRoles": [],
    "deviceCredentialAttested": false
}

Paramètres de la demande


Paramètre	Type	Obligatoire	Description
`roles`	Entier	Oui	ID du rôle. Pour trouver l'ID d'un rôle, voir Lister les rôles.
`domain`	Chaîne	Non	Domaine ActiveDirectory
`email`	Chaîne	Non	E-mail de l'utilisateur
`enableAutoLogin`	Booléen	Non	Indicateur pour activer ou désactiver la connexion automatique.
`username`	Chaîne	Oui	Nom d'utilisateur de l'utilisateur.
`password`	Chaîne	Oui	Mot de passe de l'utilisateur.
`firstName`	Chaîne	Non	Prénom de l'utilisateur
`lastName`	Chaîne	Non	Nom de l'utilisateur
`disabled`	booléen	Non	Activer ou désactiver l'utilisateur
`description`	Chaîne	Oui	Fournissez une description.
`licenseFeatures`	Chaîne	Non	Licence allouée à l'utilisateur. Vous pourrez récupérer les licences disponibles à l'aide de la fonction Répertoire de licences de la Control Room. Remarque : `licenseFeatures` est sensible à la casse et doit être saisi en MAJUSCULES. Les entrées `licenseFeatures` valides comprennent : DEVELOPMENT, RUNTIME, ANALYTICSCLIENT, ATTENDEDRUNTIME, DISCOVERYBOTANALYZER, DISCOVERYBOTRECORDER, AARIUSER, CITIZENDEVELOPER et CLOUDBOTRUNNER
`sysAssignedRoles`	Entier	Non	Rôles attribués par le système
`deviceCredentialAttested`	Chaîne	Non	Informations d'identification du périphérique attestées.

Réponse

201 Created

{
    "id": 129,
    "username": "test1",
    "domain": null,
    "firstName": "joe",
    "lastName": "doe",
    "version": 0,
    "principalId": 129,
    "deleted": false,
    "roles": [
        {
            "name": "AAE_Basic",
            "id": 185,
            "version": 1
        }
    ],
    "sysAssignedRoles": [],
    "groupNames": [],
    "permissions": [
        {
            "id": 1381,
            "action": "register",
            "resourceId": null,
            "resourceType": "devices"
        },
        {
            "id": 1346,
            "action": "createstandard",
            "resourceId": null,
            "resourceType": "credentialattribute"
        },
        {
            "id": 1378,
            "action": "view",
            "resourceId": null,
            "resourceType": "botstore"
        },
        {
            "id": 1417,
            "action": "viewuserrolebasicinfo",
            "resourceId": null,
            "resourceType": "usermanagement"
        },
        {
            "id": 1426,
            "action": "view",
            "resourceId": null,
            "resourceType": "dashboard"
        },
        {
            "id": 1376,
            "action": "view",
            "resourceId": null,
            "resourceType": "packagemanager"
        },
        {
            "id": 1305,
            "action": "run",
            "resourceId": null,
            "resourceType": "repositorymanager"
        },
        {
            "id": 1320,
            "action": "view",
            "resourceId": null,
            "resourceType": "repositorymanager"
        }
    ],
    "licenseFeatures": [
        "DEVELOPMENT"
    ],
    "emailVerified": true,
    "passwordSet": false,
    "questionsSet": false,
    "enableAutoLogin": true,
    "disabled": false,
    "clientRegistered": false,
    "description": "",
    "createdBy": 21,
    "createdOn": "2022-10-16T17:52:14Z",
    "updatedBy": 21,
    "updatedOn": "2022-10-16T17:52:14Z",
    "publicKey": null,
    "appType": null,
    "routingName": null,
    "appUrl": null,
    "email": "aaa@a.com",
    "lastLoginTime": null,
    "deviceCredentialAttested": false,
    "multipleLoginAllowed": false
}

Paramètres de la réponse


Paramètre	Type	Description
id	Entier	Identifiant unique représentant le nouvel utilisateur créé.
Rôles
nom	Chaîne	Nom du rôle.
id	Entier	ID du rôle
version	Entier	Version de l'instance de rôle.
Autorisations
autorisations	Tableau	Un tableau des autorisations uniques qui ont été assignées à l'utilisateur.
id	Entier	ID de l'autorisation.
action	Chaîne	Action associée à l'autorisation.
resourceId	Entier	ID de la ressource
resourceType	Chaîne	Type de ressource

createdBy	Entier	ID de l'utilisateur qui a créé l'utilisateur.
createdOn	Chaîne	Date et heure de la création de l'utilisateur.
updatedBy	Entier	ID de l'utilisateur qui a effectué la dernière mise à jour de l'utilisateur.
updatedOn	Chaîne	Date et heure de la dernière mise à jour de l'utilisateur.

Remarque : Vous pouvez afficher l'Control Room APIs dans la Community Edition, mais la fonctionnalité de l'API est limitée. Vous avez besoin d'une licence Automation 360 Edition pour accéder à l'ensemble des fonctionnalités API.

L'API REST répond à chaque requête par un code de réponse HTTP.Pour les codes de réponse, consultez Codes de réponse de l'API.