io.oauth.server.api

Class ClientApi

java.lang.Object

io.oauth.server.api.ClientApi

public class ClientApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ClientApi()

Method Summary

Modifier and Type	Method and Description
Client	createClient(String name, String description, String redirectUri, String userId) Create a client
void	deleteClient(String clientId) Remove a client by its client_id
List<Client>	getAllClients() Retrieves all clients
List<Client>	getAllClientsByUser(String userId) Retrieves all clients filtered by a given user_id
String	getBasePath()
Client	getClient(String clientId) Retrieves a client by its client_id
ApiInvoker	getInvoker()
static void	initialize(String providerId, String providerSecret)
Client	resetClientKeys(String clientId) Regenerate the API key's client
void	setBasePath(String basePath)
Client	updateClient(String id, String name, String description, String redirectUri, String userId) Update a client

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ClientApi

public ClientApi()

Method Detail

createClient

public Client createClient(String name,
                           String description,
                           String redirectUri,
                           String userId)
                    throws ApiException

Create a client

Parameters:

name - Name of the client's app

description - Description of the client's app

redirectUri - Whitelisted redirect uri

userId - User id of the client's app

Returns:

Client

Throws:

ApiException

deleteClient

public void deleteClient(String clientId)
                  throws ApiException

Remove a client by its client_id

Parameters:

clientId - Client id of the client to receive

Throws:

ApiException

getAllClients

public List<Client> getAllClients()
                           throws ApiException

Retrieves all clients

Returns:

List<Client>

Throws:

ApiException

getAllClientsByUser

public List<Client> getAllClientsByUser(String userId)
                                 throws ApiException

Retrieves all clients filtered by a given user_id

Parameters:

userId - User id

Returns:

List<Client>

Throws:

ApiException

getBasePath

public String getBasePath()

getClient

public Client getClient(String clientId)
                 throws ApiException

Retrieves a client by its client_id

Parameters:

clientId - Client id of the client to receive

Returns:

Client

Throws:

ApiException

getInvoker

public ApiInvoker getInvoker()

initialize

public static void initialize(String providerId,
                              String providerSecret)

resetClientKeys

public Client resetClientKeys(String clientId)
                       throws ApiException

Regenerate the API key's client

Parameters:

clientId - Client id

Returns:

Client

Throws:

ApiException

setBasePath

public void setBasePath(String basePath)

updateClient

public Client updateClient(String id,
                           String name,
                           String description,
                           String redirectUri,
                           String userId)
                    throws ApiException

Update a client

Parameters:

id - Client id of the app to update

name - Name of the client's app

description - Description of the client's app

redirectUri - Whitelisted redirect uri

userId - User id of the client's app

Returns:

Client

Throws:

ApiException