- Primeros pasos
- Autenticación
- Ámbitos y permisos
- API de gestión de plataformas
Guía de la API de Test Cloud
Actualizar usuario
Actualiza la información sobre el usuario local especificado.
No se admite el cambio de la dirección de correo electrónico de un usuario. Si es necesario cambiar la dirección de correo electrónico de un usuario (por ejemplo, debido a un cambio de dominio de la empresa), invite al usuario utilizando su nueva dirección de correo electrónico y, a continuación, elimine la cuenta asociada a la dirección antigua.
Punto final de API
PUT {accessURL}/{organizationName}/identity_/api/User/{userId}
Sustituye {accessURL} en todas las rutas de los puntos finales por la URL base de tu plataforma en la nube:
| Cloud Platform | URL de acceso |
|---|---|
| Test Cloud | https://cloud.uipath.com/ |
| Test Cloud Sector Público | https://govcloud.uipath.us/ |
| Test Cloud Dedicado | https://{customURL}.dedicated.uipath.com/ |
Ámbitos
Necesita los siguientes ámbitos:
- PM.User
- PM.User.Write
Solicitar encabezados.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
Para obtener el {access_token}, asegúrate de autenticarte a través de uno de los métodos descritos aquí.
Parámetros de ruta
| Parámetros | Tipo de datos | Descripción |
|---|---|---|
userId (obligatorio) | Cadena | El ID del usuario que quieres actualizar. |
Solicitar cuerpo
El cuerpo de la solicitud contiene la información de usuario que quieres actualizar, como el nombre, correo electrónico o pertenencia a un grupo.
{
"name": "string",
"surname": "string",
"email": "[email protected]",
"isActive": true,
"password": "string",
"groupIDsToAdd": [
"string"
],
"groupIDsToRemove": [
"string"
],
"bypassBasicAuthRestriction": true,
"invitationAccepted": true
}
{
"name": "string",
"surname": "string",
"email": "[email protected]",
"isActive": true,
"password": "string",
"groupIDsToAdd": [
"string"
],
"groupIDsToRemove": [
"string"
],
"bypassBasicAuthRestriction": true,
"invitationAccepted": true
}
Respuesta
200 OK
El grupo personalizado se actualiza con la información que has proporcionado.
400 Bad Request
No se pudo realizar la actualización.
{
"errors": {
"bypassBasicAuthRestriction": [
"Unexpected character encountered while parsing value: h. Path 'bypassBasicAuthRestriction', line 17, position 35.",
"Unexpected character encountered while parsing value: a. Path 'bypassBasicAuthRestriction', line 17, position 35."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-aec3de9099a9934e9c31e26c19f5e0dd-8c0d3d5f476c7742-00"
}
{
"errors": {
"bypassBasicAuthRestriction": [
"Unexpected character encountered while parsing value: h. Path 'bypassBasicAuthRestriction', line 17, position 35.",
"Unexpected character encountered while parsing value: a. Path 'bypassBasicAuthRestriction', line 17, position 35."
]
},
"type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
"title": "One or more validation errors occurred.",
"status": 400,
"traceId": "00-aec3de9099a9934e9c31e26c19f5e0dd-8c0d3d5f476c7742-00"
}
Solicitud de ejemplo
Supongamos que has recopilado toda la información necesaria para crear la llamada a la API.
- Su
{baseURL}es: https://cloud.uipath.com/{organizationName}/identity_ - Tu
{access_token}es:1234(para consideraciones de longitud) - Quieres actualizar la información y la pertenencia a un grupo del ID de usuario
her-1909.
La llamada debe parecerse al siguiente ejemplo (cURL):
curl --location --request PUT 'https://cloud.uipath.com/{organizationName}/identity_/api/User/her-1909' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"name": "Hermione",
"surname": "Granger-Weasley",
"email": "[email protected]",
"groupIDsToAdd": [
"gryff-01",
"alumni-02",
"teachers-03"
],
"groupIDsToRemove": [],
"bypassBasicAuthRestriction": false
}'
curl --location --request PUT 'https://cloud.uipath.com/{organizationName}/identity_/api/User/her-1909' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
"name": "Hermione",
"surname": "Granger-Weasley",
"email": "[email protected]",
"groupIDsToAdd": [
"gryff-01",
"alumni-02",
"teachers-03"
],
"groupIDsToRemove": [],
"bypassBasicAuthRestriction": false
}'
Esta es la respuesta para una llamada exitosa:
{
"succeeded": true,
"errors": []
}
{
"succeeded": true,
"errors": []
}