Interface IAPIKeys

All Known Subinterfaces:

IInternalAPIKeys

@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 uid)	Deletes an APIKey
List<APIKey>	list()
String	put(String displayName, String sid)	Put an APIKey SID for the given core session.

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

put

@PUT
@Path("_put")
String put(@QueryParam("displayName")
 String displayName,
 String sid)
    throws ServerFault

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

Parameters:

displayName - the name of the APIKey

sid - the SID of the APIKey

Returns:

UID of APIKey

Throws:

ServerFault

delete

@DELETE
@Path("{uid}")
void delete(@PathParam("uid")
 String uid)
     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