org.gbif.ws.remoteauth

Interface IdentityServiceClient

All Superinterfaces:

IdentityAccessService

public interface IdentityServiceClient
extends IdentityAccessService

Client to perform remote authentication using Basic and JWT Authentication.

Method Summary

Modifier and Type	Method and Description
default GbifUser	authenticate(String userName, String password) Authenticates a user.
GbifUser	get(String userName) Get a GbifUser by identifier (username or email).
static IdentityServiceClient	getInstance(String apiUrl, String userName, String password) Creates an instance suitable to be used by an admin user.
static IdentityServiceClient	getInstance(String apiUrl, String userName, String appKey, String secretKey) Creates an instance suitable to be used by a registered application.
LoggedUser	login(String credentials)

Method Detail

get

@GetMapping(value="admin/user/{userName}",
            produces="application/json")
 @ResponseBody
GbifUser get(@PathVariable(value="userName")
                                                                                                                String userName)

Description copied from interface: IdentityAccessService

Get a GbifUser by identifier (username or email).

Specified by:

get in interface IdentityAccessService

Parameters:

userName - username or email

Returns:

the user or null if the user is not found

authenticate

default GbifUser authenticate(String userName,
                              String password)

Description copied from interface: IdentityAccessService

Authenticates a user.

Specified by:

authenticate in interface IdentityAccessService

Parameters:

userName - username or email

password - clear text password

Returns:

the authenticated user or null if not found or wrong credentials provided

login

@PostMapping(value="user/login",
             produces="application/json")
 @ResponseBody
LoggedUser login(@RequestHeader(value="Authorization")
                                                                                                           String credentials)

getInstance

static IdentityServiceClient getInstance(String apiUrl,
                                         String userName,
                                         String appKey,
                                         String secretKey)

Creates an instance suitable to be used by a registered application.

getInstance

static IdentityServiceClient getInstance(String apiUrl,
                                         String userName,
                                         String password)

Creates an instance suitable to be used by an admin user.