net.krotscheck.kangaroo.authz.admin.v1.resource

Class UserIdentityService

java.lang.Object

net.krotscheck.kangaroo.authz.admin.v1.resource.AbstractService

net.krotscheck.kangaroo.authz.admin.v1.resource.UserIdentityService

@Path(value="/identity")
 @ScopesAllowed(value={"kangaroo:identity","kangaroo:identity_admin"})
public final class UserIdentityService
extends AbstractService

A RESTful API that permits the management of individual user identities.

Author:

Michael Krotscheck

Constructor Summary

Constructors

Constructor and Description
UserIdentityService()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	browse(int offset, int limit, String sort, SortOrder order, BigInteger ownerId, BigInteger userId, AuthenticatorType type) Browse the identities in the system.
javax.ws.rs.core.Response	createResource(UserIdentity identity) Create a new identity.
javax.ws.rs.core.Response	deleteResource(BigInteger id) Delete an scope.
protected String	getAccessScope() Return the scope required to access resources on this service.
protected String	getAdminScope() Return the scope required to access ALL resources on this services.
javax.ws.rs.core.Response	getResource(BigInteger id) Returns a specific entity.
javax.ws.rs.core.Response	search(Integer offset, Integer limit, String queryString, BigInteger ownerId, BigInteger userId, AuthenticatorType type) Search the identities in the system.
javax.ws.rs.core.Response	updateResource(BigInteger id, UserIdentity identity) Update an identity.

Methods inherited from class net.krotscheck.kangaroo.authz.admin.v1.resource.AbstractService

assertCanAccess, assertCanAccessSubresource, executeQuery, getAdminApplication, getConfig, getCurrentUser, getFullTextSession, getInjector, getSearchFactory, getSecurityContext, getSession, getUriInfo, requireEntityInput, resolveEntityInput, resolveEntityInput, resolveFilterEntity, resolveOwnershipFilter, setConfig, setFullTextSession, setInjector, setSearchFactory, setSecurityContext, setSession, setUriInfo

Methods inherited from class java.lang.Object

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

Constructor Detail

UserIdentityService

public UserIdentityService()

Method Detail

search

@GET
 @Path(value="/search")
 @Produces(value="application/json")
public javax.ws.rs.core.Response search(@DefaultValue(value="0") @QueryParam(value="offset")
                                                                                                          Integer offset,
                                                                                                          @DefaultValue(value="10") @QueryParam(value="limit")
                                                                                                          Integer limit,
                                                                                                          @DefaultValue(value="") @QueryParam(value="q")
                                                                                                          String queryString,
                                                                                                          @Optional @QueryParam(value="owner")
                                                                                                          BigInteger ownerId,
                                                                                                          @Optional @QueryParam(value="user")
                                                                                                          BigInteger userId,
                                                                                                          @Optional @QueryParam(value="type")
                                                                                                          AuthenticatorType type)

Search the identities in the system.

Parameters:

offset - The offset of the first entity to fetch.

limit - The number of entities to fetch.

queryString - The search term for the query.

ownerId - An optional user ID to filter by.

userId - An optional user ID to filter by.

type - The identity type to search by.

Returns:

A list of search results.

browse

@GET
 @Produces(value="application/json")
public javax.ws.rs.core.Response browse(@QueryParam(value="offset") @DefaultValue(value="0")
                                                                                  int offset,
                                                                                  @QueryParam(value="limit") @DefaultValue(value="10")
                                                                                  int limit,
                                                                                  @QueryParam(value="sort") @DefaultValue(value="createdDate")
                                                                                  String sort,
                                                                                  @QueryParam(value="order") @DefaultValue(value="ASC")
                                                                                  SortOrder order,
                                                                                  @Optional @QueryParam(value="owner")
                                                                                  BigInteger ownerId,
                                                                                  @Optional @QueryParam(value="user")
                                                                                  BigInteger userId,
                                                                                  @Optional @QueryParam(value="type")
                                                                                  AuthenticatorType type)

Browse the identities in the system.

Parameters:

offset - The offset of the first entity to fetch.

limit - The number of entities to fetch.

sort - The field on which the entities should be sorted.

order - The sort order, ASC or DESC.

ownerId - An optional owner ID to filter by.

userId - An optional user ID to filter by.

type - An optional authenticator type to filter by.

Returns:

A list of search results.

getResource

@GET
 @Path(value="/{id: [a-f0-9]{32}}")
 @Produces(value="application/json")
public javax.ws.rs.core.Response getResource(@PathParam(value="id")
                                                                                                                           BigInteger id)

Returns a specific entity.

Parameters:

id - The Unique Identifier for the scope.

Returns:

A response with the scope that was requested.

createResource

@POST
 @Consumes(value="application/json")
public javax.ws.rs.core.Response createResource(UserIdentity identity)

Create a new identity. Note that we only permit the creation of a password identity, on the password authenticator (for owner credentials).

Parameters:

identity - The identity to create.

Returns:

A redirect to the location where the identity was created.

updateResource

@PUT
 @Path(value="/{id: [a-f0-9]{32}}")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response updateResource(@PathParam(value="id")
                                                                                                                                                                   BigInteger id,
                                                                                                                                                                   UserIdentity identity)

Update an identity.

Parameters:

id - The Unique Identifier for the identity.

identity - The identity to update.

Returns:

A response with the identity that was updated.

deleteResource

@DELETE
 @Path(value="/{id: [a-f0-9]{32}}")
public javax.ws.rs.core.Response deleteResource(@PathParam(value="id")
                                                                                            BigInteger id)

Delete an scope.

Parameters:

id - The Unique Identifier for the scope.

Returns:

A response that indicates the successs of this operation.

getAdminScope

protected String getAdminScope()

Return the scope required to access ALL resources on this services.

Specified by:

getAdminScope in class AbstractService

Returns:

A string naming the scope.

getAccessScope

protected String getAccessScope()

Return the scope required to access resources on this service.

Specified by:

getAccessScope in class AbstractService

Returns:

A string naming the scope.