Pontos de extremidade de credenciais
Pontos de extremidade de credenciais e parâmetros
Para saber mais sobre as relações de objetos e como usá-las na API, vá para a seção Relações de objeto.
Para obter mais informações sobre credenciais, visite a página de ajuda Credenciais.
Recuperar todos os registros de credenciais
Para recuperar todos os registros de credenciais acessíveis, use o ponto de extremidade GET {baseURL}/v3/credentials.
Nota
Se você não for um administrador, os resultados serão limitados às credenciais às quais você tem acesso e visualização, e os parâmetros "userId" e "userGroupId" serão desconsiderados.
Parâmetros
view (cadeia de caracteres): opcional. Pode ser deixado sem um valor. Você pode escolher entre os seguintes valores: "Default" (padrão) e "Full" (completo). Se esse parâmetro for definido como "Default", um objeto de visualização reduzido será retornado. Quando não especificado, o valor "Default" é usado.
userId (cadeia de caracteres): opcional. Para filtrar os resultados por userId, insira o ID de um usuário.
userGroupId (cadeia de caracteres): opcional. Para filtrar os resultados por userGroupId, insira o ID de um grupo de usuários.
Recuperar um registro de credencial
Para recuperar detalhes sobre uma credencial existente, use o ponto de extremidade GET {baseURL}/v3/credentials/{credentialId}.
Parâmetros
credentialId (cadeia de caracteres): obrigatório. Insira um ID de coleção para obter as informações sobre uma credencial específica.
Criar um registro de credencial
Para criar um novo registro de credencial, use o ponto de extremidade POST {baseURL}/v3/credentials.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Esse ponto de extremidade de API é desabilitado se o TLS não está habilitado.
A API valida o nome de usuário e a senha e cria apenas credenciais para logins existentes do Windows com senhas válidas.
Parâmetros
addContract (corpo): obrigatório. Especifique o seguinte para criar uma credencial:
password (cadeia de caracteres (string)): obrigatório. Especifique a senha para o nome de usuário da nova credencial a ser adicionada.
username (cadeia de caracteres (string)): obrigatório. Especifique o nome de usuário da nova credencial a ser adicionada.
Atualizar um registro de credencial
Para atualizar um registro de credencial, use o ponto de extremidade PUT {baseURL}/v3/credentials/{credentialId}.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Esse ponto de extremidade de API é desabilitado se o TLS não está habilitado.
Esse ponto de extremidade de API valida o nome de usuário e a senha e atualiza apenas as credenciais para logins existentes do Windows com senhas válidas.
Parâmetros
updateContract (corpo): obrigatório. Especifique o seguinte para atualizar uma credencial com uma nova senha:
NewPassword (cadeia de caracteres (string)): obrigatório. Especifique a nova senha para o ID da credencial.
credentialId (cadeia de caracteres (string)): obrigatório. Insira o ID da credencial que deseja atualizar.
Compartilhar uma credencial com um usuário
Para compartilhar uma credencial existente com um usuário existente, use o ponto de extremidade POST {baseURL}/v3/credentials/{credentialId}/users.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
credentialId (cadeia de caracteres): obrigatório. Insira o ID da coleção que deseja compartilhar.
contract (corpo): obrigatório. Especifique o seguinte para compartilhar uma credencial com um usuário:
userId (cadeia de caracteres): obrigatório. Especifique o ID de um usuário com o qual deseja compartilhar uma credencial.
Compartilhar uma credencial com um grupo de usuários
Para compartilhar uma credencial existente com um grupo de usuários existente, use o ponto de extremidade POST {baseURL}/v3/credentials/{credentialId}/userGroups.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
credentialId (cadeia de caracteres): obrigatório. Insira o ID da credencial que deseja compartilhar.
contract (corpo): obrigatório. Especifique o seguinte para compartilhar uma credencial com um grupo de usuários:
userGroupId (cadeia de caracteres): obrigatório. Especifique o ID de um grupo de usuários com o qual você deseja compartilhar uma credencial.
Remover a permissão de um usuário para usar uma credencial
Para remover a permissão de um usuário para usar uma credencial existente, use o ponto de extremidade DELETE {baseURL}/v3/credentials/{credentialId}/users/{userId}.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
credentialId (cadeia de caracteres): obrigatório. Insira o ID da credencial da qual deseja remover o usuário.
userId (cadeia de caracteres): obrigatório. Insira o ID do usuário que você deseja remover da credencial.
Remover a permissão de um grupo de usuários para usar uma credencial
Para remover a permissão de um grupo de usuários para usar uma credencial existente, use o ponto de extremidade DELETE {baseURL}/v3/credentials/{credentialId}/userGroups/{userGroupId}.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
credentialId (cadeia de caracteres): obrigatório. Insira o ID da credencial da qual deseja remover o grupo de usuários.
userGroupId (cadeia de caracteres): obrigatório. Insira o ID do grupo de usuários que você deseja remover da credencial.
Excluir uma credencial
Para excluir uma credencial existente, use o ponto de extremidade DELETE {baseURL}/v3/credentials/{credentialId}.
Nota
Somente administradores podem usar esse ponto de extremidade de API.
Parâmetros
credentialId (cadeia de caracteres): obrigatório. Insira o ID da credencial que deseja excluir.
force (booleano): opcional. Selecione se deseja forçar a exclusão de uma credencial no caso de haver compartilhamentos. Se desejar que a credencial seja excluída e todos os compartilhamentos sejam apagados, defina o parâmetro force como "true" (verdadeiro). Quando não selecionado, o valor padrão é "false" (falso). Isso é para proteger contra uma chamada errada.
Relações de objetos
Para obter informações sobre IDs de credenciais existentes, use o ponto de extremidade GET /v3/credentials. O credentialId que você recebe pode ser usado quando:
Você deseja obter informações sobre uma credencial específica.
Você deseja compartilhar uma credencial com um usuário.
Você deseja compartilhar uma credencial com um grupo de usuários.
Você deseja remover um usuário de uma credencial.
Você deseja remover um grupo de usuários de uma credencial.
Você deseja excluir uma credencial específica.
Você deseja atualizar uma credencial específica.