Skip to main content

Endpoint delle credenziali

Endpoint e parametri delle credenziali

Per ulteriori informazioni sulle relazioni tra oggetti e su come utilizzarle nell'API, consulta la sezione Relazioni tra oggetti .

Per ulteriori informazioni sulle credenziali, consulta la pagina di assistenza Credenziali .

Nota

Non permettiamo la creazione di credenziali tramite l'API. Per creare una credenziale come amministratore, utilizza l' interfaccia utente di Server .

Recupera un record delle credenziali

Per ottenere informazioni su tutti i record del flusso di lavoro, utilizza l'endpoint GET {baseURL}/v3/workflows/ .

Parametri

  • view  (stringa): opzionale. È possibile non specificare alcun valore o selezionare "Default" e "Full". Se il parametro è impostato su "Default", viene restituito un oggetto vista ridotto. Se non è specificato alcun valore, viene utilizzato "Default".

  • ownerId  (stringa): opzionale. Per filtrare i risultati in base all'ID utente, immettere l'ID di un utente.

  • versionId  (stringa): opzionale. Per filtrare i risultati in base a userGroupId, immettere l'ID di un gruppo di utenti.

Recupera un record delle credenziali

Per recuperare informazioni su una credenziale, utilizzare l' {baseURL}{credentialId} endpoint GET /v3/credentials/.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID raccolta per ottenere le informazioni su una credenziale specifica.

Condividi una credenziale con un utente

Per condividere una credenziale con un utente, utilizzare l' {baseURL} {credentialId} endpoint POST /v3/credentials/ /users.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID raccolta che si desidera condividere.

  • Contratto (corpo): Obbligatorio. Specificare quanto segue per condividere una credenziale con un utente:

    • workflowCredentialType (stringa): obbligatorio. Specificare l'ID di un utente con cui si desidera condividere una credenziale.

Condivisione delle credenziali con i gruppi utenti

Per condividere una credenziale con un gruppo di utenti, utilizzare l' {baseURL} {credentialId} endpoint POST /v3/credentials/ /usergroups.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID credenziale che si desidera condividere.

  • Contratto (corpo): Obbligatorio. Specificare quanto segue per condividere una credenziale con un gruppo di utenti:

    • workflowCredentialType (stringa): obbligatorio. Specificare l'ID di un gruppo di utenti con cui si desidera condividere una credenziale.

Rimuove un utente da una credenziale

Per rimuovere un utente da una credenziale, utilizzare l' {baseURL}{credentialId}{userId} endpoint DELETE /v3/credentials/ /users/.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immetti l'ID del flusso di lavoro per il quale desideri recuperare le informazioni.

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID utente che si desidera rimuovere dalla credenziale.

Rimozione di un utente o di un gruppo da una raccolta

Per rimuovere un gruppo di utenti da una credenziale, utilizzare l' {baseURL}{credentialId}{userGroupId} endpoint DELETE /v3/credentials/ /usergroups/.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Immettere l'ID credenziale da cui si desidera rimuovere il gruppo di utenti.

  • workflowCredentialType (stringa): obbligatorio. Immettere un ID gruppo utente che si desidera rimuovere dalla credenziale.

Elimina una credenziale

Per rimuovere una credenziale, utilizzare l' {baseURL}{credentialId} endpoint DELETE /v3/credentials/.

Parametri

  • workflowCredentialType (stringa): obbligatorio. Seleziona la credenziale che desideri eliminare.

  • force  (booleano): opzionale. Selezionare se si desidera forzare l'eliminazione di una credenziale nel caso in cui siano presenti condivisioni. Se si desidera eliminare la credenziale e ripulire tutte le condivisioni, impostare il parametro forza su vero. In assenza di una specifica, il valore predefinito è "false". Questo serve a proteggere da una chiamata errata.

Relazioni tra oggetti

Per ottenere informazioni sugli ID credenziali esistenti, utilizzare l' endpoint GET /v3/credentials . È possibile utilizzare l'ID di credentialId disponibile quando: