Skip to main content

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 .

Nota

Não permitimos que as credenciais sejam criadas por meio da API. Para criar uma credencial como administrador, use a IU do Server .

Recuperar todos os registros de credenciais

Para obter informações sobre todas as credenciais, 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 informações sobre uma credencial específica, 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.

Compartilhar uma credencial com um usuário

Para compartilhar uma credencial com um usuário, use o ponto de extremidade POST {baseURL} /v3/credentials/{credentialId}/users .

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 com um grupo de usuários, use o ponto de extremidade POST {baseURL} /v3/credentials/{credentialId}/userGroups .

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 um usuário de uma credencial

Para remover um usuário de uma credencial, use o ponto de extremidade DELETE {baseURL}/v3/credentials/{credentialId}/users/{userId} .

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 um grupo de usuários de uma credencial

Para remover um grupo de usuários de uma credencial, use o ponto de extremidade DELETE {baseURL}/v3/credentials/{credentialId}/userGroups/{userGroupId} .

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 remover uma credencial, use o ponto de extremidade DELETE {baseURL}/v3/credentials/{credentialId} .

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:

Nesta secção: