net.bluemind.authentication.api

Interface IAPIKeys

All Known Implementing Classes:

APIKeysService

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

Method Summary

Modifier and Type	Method and Description
APIKey	create(java.lang.String displayName) Creates an APIKey for the given core session.
void	delete(java.lang.String sid) Deletes an APIKey
java.util.List<APIKey>	list()

Method Detail

create

@PUT
APIKey create(@QueryParam(value="displayName")
                   java.lang.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

delete

@DELETE
 @Path(value="{sid}")
void delete(@PathParam(value="sid")
                                          java.lang.String sid)
                                   throws ServerFault

Deletes an APIKey

Parameters:

sid - the APIKey.sid

Throws:

ServerFault

list

@GET
java.util.List<APIKey> list()
                          throws ServerFault

Returns:

a List of APIKey

Throws:

ServerFault