Package de.xima.fc.user_portal.api.provider.spec

Interface IUsersApi

public interface IUsersApi

High-level methods for authenticating and authorizing a user and retrieving details about a user.

Since:

8.2.0

Author:

XIMA MEDIA GmbH

Method Summary

Modifier and Type	Method	Description
IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalAuthenticatorResource>>	authenticatorsByPortal(IUserPortalInvocationContext ctx, de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalResource portal)	Retrieves all available authenticators for a user portal.
IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalAuthenticatorResource>>	authenticatorsByPortal(IUserPortalInvocationContext ctx, UUID portalUuid)	Retrieves all available authenticators for a user portal.
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.TokenResponse>	login(IUserPortalInvocationContext ctx, de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalAuthenticatorResource client, String username, String password)	Authenticates a user and returns the user.
IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.TokenResponse>	login(IUserPortalInvocationContext ctx, String clientName, String username, String password)	Authenticates a user and returns the user.

Method Detail

authenticatorsByPortal

IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalAuthenticatorResource>> authenticatorsByPortal(IUserPortalInvocationContext ctx,
                                                                                                                                   UUID portalUuid)

Retrieves all available authenticators for a user portal.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

portalUuid - The UUID of a user portal.

Returns:

A list of authenticators.

authenticatorsByPortal

IUserPortalResponse<List<de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalAuthenticatorResource>> authenticatorsByPortal(IUserPortalInvocationContext ctx,
                                                                                                                                   de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalResource portal)

Retrieves all available authenticators for a user portal.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

portal - A user portal.

Returns:

A list of authenticators.

login

IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.TokenResponse> login(IUserPortalInvocationContext ctx,
                                                                                          String clientName,
                                                                                          String username,
                                                                                          String password)

Authenticates a user and returns the user. Throws when the user could not be authenticated.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

clientName - The name of the authenticator client to use.

username - The username of the user.

password - The password of the user.

Returns:

the authenticated user.

login

IUserPortalResponse<de.xima.fc.api.rest.pub.client.user_portal.model.TokenResponse> login(IUserPortalInvocationContext ctx,
                                                                                          de.xima.fc.api.rest.pub.client.user_portal.model.UserPortalAuthenticatorResource client,
                                                                                          String username,
                                                                                          String password)

Authenticates a user and returns the user. Throws when the user could not be authenticated.

Parameters:

ctx - Invocation context for communicating with the user portal REST API.

client - The authenticator client to use.

username - The username of the user.

password - The password of the user.

Returns:

the authenticated user.