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 .
Recupero di tutti i record delle credenziali
Per ottenere informazioni su tutte le credenziali, utilizza l'endpoint
GET {baseURL}/v3/credentials
.
Nota
Se non sei un amministratore, nei risultati vengono incluse solo le credenziali a cui hai accesso e i parametri view, userid e userGroupId vengono ignorati.
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".
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.
Recupero del record di una credenziale
Per recuperare informazioni su una credenziale, utilizza l'endpoint
GET {baseURL}/v3/credentials/{credentialId}
.
Parametri
credentialId (stringa): obbligatorio. Immetti l'ID di una raccolta per ottenere informazioni in merito a una credenziale specifica.
Condivisione di una credenziale con un utente
Per condividere una credenziale con un utente, utilizza l'endpoint
POST {baseURL}
/v3/credentials/{credentialId}/users
.
Parametri
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.
Condivisione di una credenziale con un gruppo di utenti
Per condividere una credenziale con un gruppo di utenti, utilizza l'endpoint
POST {baseURL}
/v3/credentials/{credentialId}/userGroups
.
Parametri
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.
Rimozione di un utente da una credenziale
Per rimuovere un utente da una credenziale, utilizza l'endpoint
DELETE {baseURL}/v3/credentials/{credentialId}/users/{userId}
.
Parametri
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.
Rimozione di un gruppo di utenti da una credenziale
Per rimuovere un gruppo di utenti da una credenziale, utilizza l'endpoint
DELETE {baseURL}/v3/credentials/{credentialId}/userGroups/{userGroupId}
.
Parametri
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.
Eliminazione di una credenziale
Per rimuovere una credenziale, utilizza l'endpoint
DELETE {baseURL}/v3/credentials/{credentialId}
.
Parametri
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.
Relazioni tra oggetti
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