Obtener configuración

Utiliza este punto final para recuperar la lista de pares de valor clave para los ajustes de correo electrónico y autenticación.

Punto final de API

GET https://cloud.uipath.com/{organizationName}/identity_/api/Setting

Ámbitos

Necesita los siguientes ámbitos:

• PM.Setting
• PM.Setting.Read

Solicitar encabezados.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Nota: para obtener el {access_token}, asegúrate de autenticar a través de uno de los métodos descritos aquí.

Parámetros de consulta

Parámetros de consulta	Tipo de datos	Descripción
key (opcional)	Cadena	Introduce el nombre de la configuración que quieres recuperar. Por ejemplo, para recuperar la configuración de dominios SMTP, introduce key=Email.Smtp.Domain.
partitionGlobalId (opcional)	Cadena	El ID de la organización para la que desea recuperar la configuración.
userId (opcional)	Cadena	El ID de la usuario para la que desea recuperar la configuración.

Respuesta

200 OK

Devuelve las cuentas de UiPath Robot consultadas.

Solicitud de ejemplo

Supongamos que has recopilado toda la información necesaria para crear la llamada a la API.

• Tu {baseURL} es: https://cloud.uipath.com/{organizationName}/{tenantName}/
• Tu {access_token} es: 1234 (para consideraciones de longitud)
• El {partitionGlobalId} es: magic-7
• Si quieres recuperar la configuración global del correo electrónico, inicia sesión como administrador del host. En tal caso, no necesitarás proporcionar una userID.

La llamada debe parecerse al siguiente ejemplo (cURL):

curl --location --request GET 'https://cloud.uipath.com/{organizationName}/{tenantName}/identity_/api/Setting?partitionGlobalId=magic-7&key=Email.Smtp.Domain&key=Email.Smtp.EnableSsl&key=Email.Smtp.FromDisplayName&key=Email.Smtp.FromEmail&key=Email.Smtp.Host&key=Email.Smtp.Password&key=Email.Smtp.Port&key=Email.Smtp.UseDefaultCredentials&key=Email.Smtp.UserName' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Aquí está el body de respuesta de una llamada correcta:

[
    {
        "id": 6,
        "key": "Email.Smtp.FromEmail",
        "value": "[e-mail]",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 7,
        "key": "Email.Smtp.FromDisplayName",
        "value": "Hogwarts server - 21.10 - Clean",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 15,
        "key": "Email.Smtp.Domain",
        "value": "",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 16,
        "key": "Email.Smtp.EnableSsl",
        "value": "true",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 17,
        "key": "Email.Smtp.Port",
        "value": "587",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 18,
        "key": "Email.Smtp.UseDefaultCredentials",
        "value": "false",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 19,
        "key": "Email.Smtp.UserName",
        "value": "[e-mail]",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 20,
        "key": "Email.Smtp.Host",
        "value": "smtp.gmail.com",
        "partitionGlobalId": "magic-7",
        "userId": null
    },
    {
        "id": 21,
        "key": "Email.Smtp.Password",
        "value": "protego-spell",
        "partitionGlobalId": "magic-7",
        "userId": null
    }
]