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.
Per recuperare tutti i record delle credenziali accessibili, utilizza l'endpoint GET {baseURL}/v3/credentials.
Nota
Se non sei un amministratore, nei risultati verranno incluse solo le credenziali a cui hai accesso, mentre i parametri view, userid e userGroupId verranno ignorati.
view (stringa): opzionale. È possibile non specificare nessun valore o selezionare tra "Default" e "Full". Quando il parametro è impostato su "Default", viene restituito un oggetto vista ridotto. Se non viene invece specificato alcun valore, viene utilizzato "Default".
userId (stringa): opzionale. Per filtrare i risultati in base a userId, immetti l'ID di un utente.
userGroupId (stringa): opzionale. Per filtrare i risultati in base a userGroupId, immetti l'ID di un gruppo di utenti.
Per recuperare i dettagli relativi a una credenziale esistente, utilizza l'endpoint GET {baseURL}/v3/credentials/{credentialId}.
credentialId (stringa): obbligatorio. Immetti l'ID di una raccolta per ottenere informazioni in merito a una credenziale specifica.
Per creare un nuovo record di credenziali, utilizza l'endpoint POST {baseURL}/v3/credentials.
Nota
Solo gli amministratori possono usare questo endpoint API.
Questo endpoint API non funziona se il TLS per l'interfaccia utente di Server è disattivato.
L'API convalida il nome utente e la password e crea solamente le credenziali per gli accessi Windows esistenti con password valide.
addContract (corpo): obbligatorio. Per creare una nuova combinazione di credenziali, specifica quanto segue:
password (stringa): obbligatorio. Specifica la password per il nome utente della nuova combinazione di credenziali da aggiungere.
username (stringa): obbligatorio. Specifica il nome utente della nuova combinazione di credenziali da aggiungere.
Per aggiornare un record di credenziali, utilizza l'endpoint PUT {baseURL}/v3/credentials/{credentialId}.
Nota
Solo gli amministratori possono usare questo endpoint API.
Questo endpoint API non funziona se il TLS per l'interfaccia utente di Server è disattivato.
Questo endpoint dell'API convalida il nome utente e la password e aggiorna solamente le credenziali per gli accessi Windows esistenti con password endpoint valide.
updateContract (corpo): obbligatorio. Specifica quanto segue per modificare la password di una combinazione di credenziali:
NewPassword (stringa): obbligatorio. Specifica la nuova password per l'ID della combinazione di credenziali.
credentialId (stringa): obbligatorio. Immetti l'ID della credenziale da aggiornare.
Per condividere una credenziale con un utente esistente, utilizza l'endpoint POST {baseURL}/v3/credentials/{credentialId}/users.
Nota
Solo gli amministratori possono usare questo endpoint API.
credentialId (stringa): obbligatorio. Immetti l'ID di una raccolta che desideri condividere.
contract (corpo): obbligatorio. Specifica quanto segue per condividere una credenziale con un utente:
userId (stringa): obbligatorio. Specifica l'ID di un utente con cui desideri condividere una credenziale.
Per condividere una credenziale con un gruppo di utenti esistente, utilizza l'endpoint POST {baseURL}/v3/credentials/{credentialId}/userGroups.
Nota
Solo gli amministratori possono usare questo endpoint API.
credentialId (stringa): obbligatorio. Immetti l'ID di una credenziale che desideri condividere.
contract (corpo): obbligatorio. Specifica quanto segue per condividere una credenziale con un gruppo di utenti:
userGroupId (stringa): obbligatorio. Specifica l'ID di un gruppo di utenti con cui desideri condividere una credenziale.
Per impedire a un utente di utilizzare una credenziale esistente, utilizza l'endpoint DELETE {baseURL}/v3/credentials/{credentialId}/users/{userId}.
Nota
Solo gli amministratori possono usare questo endpoint API.
credentialId (stringa): obbligatorio. Immetti l'ID della credenziale da cui desideri rimuovere l'utente.
userId (stringa): obbligatorio. Immetti l'ID di un utente che desideri rimuovere dalla credenziale.
Per impedire a un gruppo di utenti di utilizzare una credenziale esistente, utilizza l'endpoint DELETE {baseURL}/v3/credentials/{credentialId}/userGroups/{userGroupId}.
Nota
Solo gli amministratori possono usare questo endpoint API.
credentialId (stringa): obbligatorio. Immetti l'ID della credenziale da cui desideri rimuovere il gruppo di utenti.
userGroupId (stringa): obbligatorio. Immetti l'ID di un gruppo di utenti che desideri rimuovere dalla credenziale.
Per eliminare una credenziale esistente, utilizza l'endpoint DELETE {baseURL}/v3/credentials/{credentialId}.
Nota
Solo gli amministratori possono usare questo endpoint API.
credentialId (stringa): obbligatorio. Immetti l'ID della credenziale che desideri eliminare.
force (booleano): opzionale. Scegli se forzare l'eliminazione di una credenziale in presenza di condivisioni. Se desideri eliminare la credenziale e rimuovere tutte le condivisioni, imposta il parametro force su true. In assenza di una specifica, il valore predefinito è false. Ciò consente di evitare una chiamata errata.
Per informazioni sugli ID delle credenziali esistenti, utilizza l'endpoint GET /v3/credentials. Il parametro credentialId risultante può essere utilizzato nei seguenti casi:
Quando desideri avere informazioni su una credenziale specifica
Quando desideri condividere una credenziale con un utente
Quando desideri condividere una credenziale con un gruppo di utenti
Quando desideri rimuovere un utente da una credenziale
Quando desideri rimuovere un gruppo di utenti da una credenziale
Quando desideri eliminare una credenziale specifica
Quando desideri aggiornare una combinazione di credenziali specifica