Service enfonica.voice.v1beta1.Users¶

Methods¶

CreateUser
rpc CreateUser(CreateUserRequest) returns (User) Creates a user. The caller must have `voice.users.create` permission on the project.

DeleteUser
rpc DeleteUser(DeleteUserRequest) returns (google.protobuf.Empty) Deletes the specified user. The caller must have `voice.users.delete` permission on the project.

GetUser
rpc GetUser(GetUserRequest) returns (User) Retrieves a user identified by the supplied resource name. The caller must have `voice.users.get` permission on the project.

ListUsers
rpc ListUsers(ListUsersRequest) returns (ListUsersResponse) Lists all Users. List returns user sorted by create_time descending. The caller must have `voice.users.list` permission on the project.

UpdateUser
rpc UpdateUser(UpdateUserRequest) returns (User) Updates a user. The caller must have `voice.users.update` permission on the project.

The User resource.

Fields
name	string Resource name of the user. It is of the form `projects/{project_id}/sipDomains/{sip_domain_id}/users/{user_id}`.
user_id	string Output only. The username. This is a convenience field for the `user_id` component of the resource name. This forms the user's address of record, in the form `{user_id}@{fqdn}`.
password	string Input only. The password. It must be a minimum of 12 characters, consisting of uppercase and lowercase letters and digits. Once the password is set, it cannot be retrieved. It is stored hashed.
address	string Output only. The address represented by this user. This is the user's address of record, in the form {user_id}@{fqdn}.
create_time	google.protobuf.Timestamp Output only. The creation time of the user.

Request to create a new user.

Fields
parent	string Required. The SIP domain under which to create the user in the form `projects//sipDomains/`.
user	User Required. The user resource to be created.
user_id	string Required. The username of the user, and also the {user_id} component of the created resource's name, which will be of the form `projects/{project_id}/sipDomains/{sip_domain_id}/users/{user_id}`. This must be lowercase alpha-numeric or hyphens and must start and end with an alpha-numeric character, and must be a minimum of 2 and maximum of 30 characters. This is captured in the following regular expression: ^[a-z0-9][a-z0-9-]{0,28}[a-z0-9]$

The GetUser request message.

Fields
name	string Required. The resource name of the user to retrieve. Must be of the form `projects//sipDomains//users/*`.

The ListUsers request.

Fields
parent	string Required. The SIP domain under which to list users, in the form `projects//sipDomains/`.
page_size	int32 The maximum number of users to return in the response. Default value of 10 and maximum value of 100.
page_token	string A pagination token returned from a previous call to `ListUsers` that indicates where this listing should continue from.

The ListUsers response.

Fields
users[]	User A possibly paginated list of user that are direct descendants of the specified parent resource.
next_page_token	string A pagination token returned from a previous call to `ListUsers` that indicates from where listing should continue.

The request message for updating a user's properties.

Fields
user	User Required. The new definition of the User.
update_mask	google.protobuf.FieldMask Fields to be updated.

The DeleteUser request message.

Fields
name	string Required. The resource name of the user to be deleted. Must be of the form `projects//sipDomains//users/*`.