Compartilhar via

Obter funções PAM

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

Observação

As URLs neste artigo são relativas ao nome do host escolhido durante a implantação da API, como https://api.contoso.com.

Solicitação

Método URL da solicitação
Conseguir /api/pamresources/pamroles

Parâmetros de consulta

Parâmetro Descrição
$filter Opcional. Especifique qualquer uma das propriedades da função PAM em uma expressão de filtro para retornar uma lista filtrada de respostas. Para obter mais informações sobre operadores com suporte, consulte Filtragem nos detalhes do serviço da API REST do PAM.
v Opcional. A versão da API. Se não estiver incluída, a versão atual (lançada mais recentemente) da API será usada. Para obter mais informações, consulte Controle de versão nos detalhes do serviço da API REST do PAM.

Cabeçalhos de solicitação

Para obter cabeçalhos de solicitação comuns, consulte cabeçalhos de solicitação e resposta HTTP nos detalhes do serviço da API REST do PAM .

Corpo da solicitação

Nenhum.

Resposta

Esta seção descreve a resposta.

Códigos de resposta

Código Descrição
200 OKEY
401 Desautorizado
403 Proibido
408 Tempo Limite da Solicitação
500 Erro interno do servidor
503 Serviço indisponível

Cabeçalhos de resposta

Para obter cabeçalhos de solicitação comuns, consulte cabeçalhos de solicitação e resposta HTTP nos detalhes do serviço da API REST do PAM .

Corpo da resposta

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

Propriedade Descrição
RoleID O GUID (identificador exclusivo) da função PAM.
Nome de Exibição Nome de exibição da função THe PAM no serviço MIM.
Descrição A descrição da função PAM no serviço MIM.
TTL O tempo limite máximo de expiração dos direitos de acesso da função em segundos.
AvailableFrom A hora mais antiga do dia em que uma solicitação é ativada.
AvailableTo A hora mais recente do dia em que uma solicitação é ativada.
MFAEnabled Um valor booliano que indica se as solicitações de ativação para essa função exigem um desafio de MFA.
ApprovalEnabled Um valor booliano que indica se as solicitações de ativação para essa função exigem aprovação por um proprietário de função.
AvailabilityWindowEnabled Um valor booliano que indica se a função só pode ser ativada durante um intervalo de tempo especificado.

Exemplo

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

Exemplo: Solicitação

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":"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