Package net.bluemind.authentication.api

Interface IAPIKeys

@Path("/auth/keys")
public interface IAPIKeys

Method Summary

Modifier and Type	Method	Description
APIKey	create(String displayName)	Creates an APIKey for the given core session.
void	delete(String sid)	Deletes an APIKey
APIKey	get(String sid)
List<APIKey>	list()
List<APIKey>	listAll()
APIKey	store(String key, String displayName)	Creates an APIKey for the given core session using the provided key as SID.

Method Details

create

@PUT
APIKey create(@QueryParam("displayName")
 String displayName)
       throws ServerFault

Creates an APIKey for the given core session. This will be usable as a valid password to impersonate the user.

Parameters:

displayName - the name of the APIKey

Returns:

an APIKey to impersonate the user

Throws:

ServerFault

store

@PUT
@Path("{key}")
APIKey store(@PathParam("key")
 String key,
 @QueryParam("displayName")
 String displayName)
      throws ServerFault

Creates an APIKey for the given core session using the provided key as SID. The key will be usable as a valid password to impersonate the user.

Parameters:

key - SID the name of the APIKey

displayName - the name of the APIKey

Returns:

an APIKey to impersonate the user

Throws:

ServerFault

delete

@DELETE
@Path("{sid}")
void delete(@PathParam("sid")
 String sid)
     throws ServerFault

Deletes an APIKey

Parameters:

sid - the APIKey.sid

Throws:

ServerFault

list

@GET
List<APIKey> list()
           throws ServerFault

Returns:

a List of APIKey

Throws:

ServerFault

listAll

@GET
@Path("_all")
List<APIKey> listAll()

get

@GET
@Path("{sid}")
APIKey get(@PathParam("sid")
 String sid)
    throws ServerFault

Throws:

ServerFault