From 31651c978e921e9e46cddd455f103fcf4b1a332a Mon Sep 17 00:00:00 2001 From: David Lawrence Date: Wed, 12 Oct 2016 21:45:15 +0000 Subject: Bug 1307003 - Add whoami endpoint r=dylan --- Bugzilla/WebService/User.pm | 66 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) (limited to 'Bugzilla/WebService') diff --git a/Bugzilla/WebService/User.pm b/Bugzilla/WebService/User.pm index d69df5056..602e7e2cc 100644 --- a/Bugzilla/WebService/User.pm +++ b/Bugzilla/WebService/User.pm @@ -40,6 +40,7 @@ use constant PUBLIC_METHODS => qw( offer_account_by_email update valid_login + whoami ); use constant MAPPED_FIELDS => { @@ -428,6 +429,16 @@ sub _login_to_hash { return $item; } +sub whoami { + my ($self, $params) = @_; + my $user = Bugzilla->login(LOGIN_REQUIRED); + return filter $params, { + id => $self->type('int', $user->id), + real_name => $self->type('string', $user->name), + name => $self->type('email', $user->login), + }; +} + 1; __END__ @@ -1130,3 +1141,58 @@ in Bugzilla B<4.4>. =back =back + +=head2 whoami + +=over + +=item B + +Allows for validating a user's API key, token, or username and password. +If sucessfully authenticated, it returns simple information about the +logged in user. + +=item B (none) + +=item B + +On success, a hash containing information about the logged in user. + +=over + +=item id + +C The unique integer ID that Bugzilla uses to represent this user. +Even if the user's login name changes, this will not change. + +=item real_name + +C The actual name of the user. May be blank. + +=item name + +C The login name of the user. + +=back + +=item B + +=over + +=item 300 (Invalid Username or Password) + +The username does not exist, or the password is wrong. + +=item 301 (Account Disabled) + +The account has been disabled. A reason may be specified with the +error. + +=item 305 (New Password Required) + +The current password is correct, but the user is asked to change +his password. + +=back + +=back -- cgit v1.2.3-24-g4f1b