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 vengono incluse solo le credenziali a cui hai accesso e i parametri view, userid e userGroupId vengono ignorati.
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.
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.
To create a credential record, use the POST {baseURL}/v3/credentials endpoint.
Nota
Only Curators can use this API endpoint.
This API endpoint is disabled if TLS is not enabled.
The API validates the username and password and only creates credentials for existing Windows logins with valid passwords.
addContract (body): Required. Specify the following to create a new credential:
password (string) Required. Specify the password for the username of the new credential to be added.
username (string) Required. Specify the username of the new credential to be added.
To update a credential record, use the PUT {baseURL}/v3/credentials/{credentialId} endpoint.
Nota
Only Curators can use this API endpoint.
This API endpoint is disabled if TLS is not enabled.
This API endpoint validates the username and password and only updates credentials for existing Windows logins with valid passwords.
updateContract (body): Required. Specify the following to update a credential with a new password:
NewPassword (string): Required. Specify the new password for the credential ID.
credentialId (string) Required. Enter the ID of the credential to update.
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
You want to update a specific credential.