Obter funções de PAM

Utilizado por uma conta com privilégios para listar as funções de PAM para as quais a conta é candidata.

Nota

Os URLs neste artigo são relativos ao nome do anfitrião escolhido durante a implementação da API, como https://api.contoso.com.

Pedir

Método	URL do Pedido
GET	/api/pamresources/pamroles

Parâmetros de consulta

Parâmetro	Description
$filter	Opcional. Especifique qualquer uma das propriedades da função PAM numa expressão de filtro para devolver uma lista filtrada de respostas. Para obter mais informações sobre os operadores suportados, veja Filtering in PAM REST API service details (Filtrar nos detalhes do serviço API REST de PAM).
v	Opcional. A versão da API. Se não estiver incluída, é utilizada a versão atual (lançada mais recentemente) da API. Para obter mais informações, veja Versioning in PAM REST API service details (Controlo de versões no serviço API REST de PAM).

Cabeçalhos do pedido

Para obter cabeçalhos de pedidos comuns, veja Cabeçalhos de pedidos e respostas HTTP nos detalhes do serviço API REST de PAM.

Corpo do pedido

Nenhum.

Resposta

Esta secção descreve a resposta.

Códigos de resposta

Código	Descrição
200	OK
401	Não autorizado
403	Proibido
408	Tempo Limite do Pedido
500	Erro de Servidor Interno
503	Serviço Indisponível

Cabeçalhos de resposta

Para obter cabeçalhos de pedidos comuns, veja Cabeçalhos de pedidos e respostas HTTP nos detalhes do serviço API REST de PAM.

Corpo da resposta

Uma resposta bem-sucedida contém uma coleção de uma ou mais funções de PAM, cada uma das quais tem as seguintes propriedades:

Propriedade	Descrição
RoleID	O identificador exclusivo (GUID) da função de PAM.
DisplayName	O nome a apresentar da função PAM no serviço MIM.
Description	Descrição da função PAM no serviço MIM.
TTL	Os direitos de acesso da função excedem o tempo limite de expiração em segundos.
DisponívelA partir de	A hora mais antiga do dia em que um pedido é ativado.
DisponívelPara	A hora mais recente do dia em que um pedido é ativado.
MFAEnabled	Um valor booleano que indica se os pedidos de ativação para esta função requerem um desafio de MFA.
ApprovalEnabled	Um valor booleano que indica se os pedidos de ativação para esta função requerem a aprovação de um proprietário de função.
AvailabilityWindowEnabled	Um valor booleano que indica se a função só pode ser ativada durante um intervalo de tempo especificado.

Exemplo

Esta secção fornece um exemplo para obter as funções de PAM.

Exemplo: Pedido

GET /api/pamresources/pamroles HTTP/1.1

Exemplo: Resposta

HTTP/1.1 200 OK

{
    "odata.metadata":"http://localhost:8086/api/pamresources/%24metadata#pamroles",
    "value":[
        {
            "RoleId":"8f5cec1a-ecba-42ec-b76d-e6e0e4bf4c62",
            "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":"c28eab4a-95cf-4c08-a153-d5e8a9e660cd",
            "DisplayName":"ApprovalRole",
            "Description":null,
            "TTL":"3600",
            "AvailableFrom":"0001-01-01T00:00:00",
            "AvailableTo":"0001-01-01T00:00:00",
            "MFAEnabled":false,
            "ApprovalEnabled":true,
            "AvailabilityWindowEnabled":false
        }
    ]
}