List Users - List Users

Service:

Azure confidential ledger

Version d'API:

2024-12-09-preview

Obtient des détails sur une liste d’utilisateurs.
Les ID d’objet de tous les utilisateurs et le rôle unique par utilisateur seront renvoyés.

GET {ledgerEndpoint}/app/users?api-version=2024-12-09-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
ledgerEndpoint	path	True	string (url)	URL du registre confidentiel, par exemple https://contoso.confidentialledger.azure.com
api-version	query	True	string	Version de l’API à utiliser avec la requête HTTP.

Réponses

Nom	Type	Description
200 OK	PagedUsers	Utilisateurs dans la plage spécifiée paginée.
Other Status Codes	ConfidentialLedgerError	Réponse d’erreur décrivant le motif de l’échec de l’opération

Exemples

ListUserEntries

Exemple de requête

HTTP

GET {ledgerEndpoint}/app/users?api-version=2024-12-09-preview

Exemple de réponse

Code d’état:

200

{
  "ledgerUsers": [
    {
      "assignedRole": "Administrator",
      "userId": "Certificate object id 1"
    },
    {
      "assignedRole": "Contributor",
      "userId": "AAD object id 2"
    },
    {
      "assignedRole": "Reader",
      "userId": "AAD object id 3"
    }
  ]
}

Définitions

Nom	Description
ConfidentialLedgerError	Réponse d’erreur du registre confidentiel.
ConfidentialLedgerErrorBody	Réponse d’erreur du registre confidentiel.
ConfidentialLedgerUserRoleName	Représente un rôle assignable.
LedgerUser	Détails sur un utilisateur de registre confidentiel.
PagedUsers	Utilisateurs paginés retournés en réponse à une requête.

ConfidentialLedgerError

Object

Réponse d’erreur du registre confidentiel.

Nom	Type	Description
error	ConfidentialLedgerErrorBody	Réponse d’erreur du registre confidentiel.

ConfidentialLedgerErrorBody

Object

Réponse d’erreur du registre confidentiel.

Nom	Type	Description
code	string	Code d’erreur.
message	string	Message d’erreur.

ConfidentialLedgerUserRoleName

Énumération

Représente un rôle assignable.

Valeur	Description
Administrator
Contributor
Reader

LedgerUser

Object

Détails sur un utilisateur de registre confidentiel.

Nom	Type	Description
assignedRole	ConfidentialLedgerUserRoleName	Représente un rôle assignable.
userId	string	Identificateur de l’utilisateur. Il doit s’agir d’un ID d’objet AAD ou d’une empreinte digitale de certificat.

PagedUsers

Object

Utilisateurs paginés retournés en réponse à une requête.

Nom	Type	Description
ledgerUsers	LedgerUser[]	Détails sur un utilisateur de registre confidentiel.
nextLink	string	Chemin d’accès à partir duquel récupérer la page suivante des résultats.