Compartir a través de

Obtención de roles de PAM

Usado por una cuenta con privilegios para enumerar los roles de PAM para los que la cuenta es candidata.

Nota:

Las direcciones URL de este artículo son relativas al nombre de host elegido durante la implementación de la API, como https://api.contoso.com.

Solicitud

Método URL de solicitud
OBTÉN /api/pamresources/pamroles

Parámetros de consulta

Parámetro Descripción
$filter Opcional. Especifique cualquiera de las propiedades de rol de PAM en una expresión de filtro para devolver una lista filtrada de respuestas. Para obtener más información sobre los operadores admitidos, consulte Filtrado en los detalles del servicio de API REST de PAM.
v Opcional. La versión de la API. Si no se incluye, se usa la versión actual (publicada más recientemente) de la API. Para obtener más información, consulte Control de versiones en los detalles del servicio api rest de PAM.

Encabezados de solicitud

Para obtener encabezados de solicitud comunes, consulte encabezados de solicitud y respuesta HTTP en detalles del servicio de API REST de PAM.

Cuerpo de la solicitud

Ninguno.

Respuesta

En esta sección se describe la respuesta.

Códigos de respuesta

Código Descripción
200 De acuerdo
401 Desautorizado
403 Prohibido
408 Tiempo de espera de solicitud
500 Error interno del servidor
503 Servicio no disponible

Encabezados de respuesta

Para obtener encabezados de solicitud comunes, consulte encabezados de solicitud y respuesta HTTP en detalles del servicio de API REST de PAM.

Cuerpo de la respuesta

Una respuesta correcta contiene una colección de uno o varios roles de PAM, cada uno de los cuales tiene las siguientes propiedades:

Propiedad Descripción
RoleID Identificador único (GUID) del rol PAM.
DisplayName Nombre para mostrar del rol DE PAM en el servicio MIM.
Descripción Descripción del rol PAM en el servicio MIM.
TTL Tiempo de espera máximo de expiración de los derechos de acceso del rol en segundos.
AvailableFrom La hora más temprana del día cuando se activa una solicitud.
AvailableTo Hora más reciente del día en que se activa una solicitud.
MFAEnabled Valor booleano que indica si las solicitudes de activación para este rol requieren un desafío de MFA.
ApprovalEnabled Valor booleano que indica si las solicitudes de activación para este rol requieren aprobación por parte de un propietario de rol.
AvailabilityWindowEnabled Valor booleano que indica si el rol solo se puede activar durante un intervalo de tiempo especificado.

Ejemplo

En esta sección se proporciona un ejemplo para obtener los roles de PAM.

Ejemplo: solicitud

GET /api/pamresources/pamroles HTTP/1.1

Ejemplo: respuesta

HTTP/1.1 200 OK

{
    "odata.metadata":"http://localhost:8086/api/pamresources/%24metadata#pamroles",
    "value":[
        {
            "RoleId":"00000000-0000-0000-0000-000000000000",
            "DisplayName":"Allow AD Access ",
            "Description":null,
            "TTL":"3600",
            "AvailableFrom":"0001-01-01T00:00:00",
            "AvailableTo":"0001-01-01T00:00:00",
            "MFAEnabled":false,
            "ApprovalEnabled":false,
            "AvailabilityWindowEnabled":false
        },
        {
            "RoleId":"00000000-0000-0000-0000-000000000000",
            "DisplayName":"ApprovalRole",
            "Description":null,
            "TTL":"3600",
            "AvailableFrom":"0001-01-01T00:00:00",
            "AvailableTo":"0001-01-01T00:00:00",
            "MFAEnabled":false,
            "ApprovalEnabled":true,
            "AvailabilityWindowEnabled":false
        }
    ]
}
  • Last updated on