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 um registro de credencial

Para obter informações sobre todos os registros de fluxos de trabalho, use o ponto de extremidade GET {baseURL}/v3/workflows/ .

Nota

Se você não for um Curador, os resultados serão limitados às Credenciais às quais você tem acesso e visualização, os parâmetros UserId e userGroupId serão desconsiderados.

Parâmetros

  • view (cadeia de caracteres): opcional. Pode ser deixado sem um valor. Você pode selecionar 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.

  • limit (cadeia de caracteres): opcional. Para filtrar os resultados por UserId, insira o ID de um usuário.

  • limit (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 obter informações sobre um fluxo de trabalho específico, use o ponto de extremidade GET {baseURL}/v3/workflows/{credentialId} .

Parâmetros

  • credentialId (cadeia de caracteres): opcional. 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 {baseURL} endpoint POST /v3/credentials{credentialId}/ /users .

Parâmetros

  • credentialId (cadeia de caracteres): opcional. Introduza uma ID de coleção que pretende partilhar.

  • Contrato (corpo): Obrigatório. Especifique o seguinte para compartilhar uma credencial com um usuário:

    • workflowCredentialType (cadeia de caracteres): obrigatório. Especifique o ID de um usuário com o qual você deseja compartilhar uma credencial.

Compartilhar credenciais com grupos de usuários

Para compartilhar uma credencial com um grupo de usuários, use o {baseURL} endpoint POST /v3/credentials/{credentialId}/Usergroups .

Parâmetros

  • credentialId (cadeia de caracteres): opcional. Insira um ID de credencial que você deseja compartilhar.

  • Contrato (corpo): Obrigatório. Especifique o seguinte para compartilhar uma credencial com um grupo de usuários:

    • workflowCredentialType (cadeia de caracteres): obrigatório. Especifique o ID de um grupo de usuários com o qual você deseja compartilhar uma credencial.

Remove um usuário de uma credencial

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

Parâmetros

  • credentialId (cadeia de caracteres): opcional. Insira o ID fluxo de trabalho para o qual deseja recuperar as informações.

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira um ID de usuário que você deseja remover da credencial.

Remover um usuário ou grupo de uma coleção

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

Parâmetros

  • credentialId (cadeia de caracteres): opcional. Introduza o ID da credencial a partir do qual pretende remover o grupo de utilizadores.

  • workflowCredentialType (cadeia de caracteres): obrigatório. Insira um ID de grupo de usuários que você deseja remover da credencial.

Excluir uma credencial

Para excluir um fluxo de trabalho específico, use o ponto de extremidade DELETE {baseURL}/v3/workflows/{credentialId} .

Parâmetros

  • credentialId (cadeia de caracteres): opcional. Selecione a credencial que deseja excluir.

  • force (booleano): opcional. Selecione se deseja forçar a exclusão de uma credencial no caso de haver compartilhamentos. Se você quiser que a credencial seja excluída e todos os compartilhamentos sejam limpos, defina o parâmetro force como true. Quando não selecionado, o valor padrão é "false". Isto é para proteger contra uma chamada errante.

Relações de objetos

Para obter informações sobre um fluxo de trabalho específico, use o ponto de extremidade GET /v3/workflows/ . O credentialId que você recebe pode ser usado quando:

Nesta secção: