Skip to content

Commit

Permalink
Add additional rights and clarifications to user management API (#11908)
Browse files Browse the repository at this point in the history
* user management: document optional primary party

CHANGELOG_BEGIN
CHANGELOG_END

Breaks-protobuf: true
  • Loading branch information
meiersi-da authored Dec 2, 2021
1 parent b02ed77 commit c19e3f5
Showing 1 changed file with 11 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ service UserManagementService {
rpc GetUser (GetUserRequest) returns (User);

// Delete an existing user and all its rights.
rpc DeleteUser (DeleteUserRequest) returns (google.protobuf.Empty);
rpc DeleteUser (DeleteUserRequest) returns (DeleteUserResponse);

// List the all existing users.
rpc ListUsers (ListUsersRequest) returns (ListUsersResponse);
Expand Down Expand Up @@ -72,9 +72,16 @@ message User {
// The primary party as which this user reads and acts by default on the ledger
// _provided_ it has the corresponding ``CanReadAs(primary_party)`` or
// ``CanActAs(primary_party)`` rights.
//
// Ledger API clients SHOULD set this field to a non-empty value for all users to
// enable the users to act on the ledger using their own Daml party.
// Ledger API clients MAY set this field to empty for special users; e.g., a user
// that is granted ``CanReadAsAnyParty`` so that it can export the data for all parties
// hosted on the participant node.
string primary_party = 2;
}


// A right granted to a user.
message Right {
// The user is allowed to administrate the participant node.
Expand Down Expand Up @@ -123,6 +130,9 @@ message DeleteUserRequest {
string user_id = 1;
}

message DeleteUserResponse {
}

// Required authorization: ``HasRight(ParticipantAdmin)``
message ListUsersRequest {
// TODO: add pagination, cf. https://cloud.google.com/apis/design/design_patterns#list_pagination
Expand Down

0 comments on commit c19e3f5

Please sign in to comment.