Package org.nuxeo.scim.v2.rest.usermanager

Class ScimV2UserObject

java.lang.Object

org.nuxeo.scim.v2.rest.usermanager.ScimV2BaseUMObject

org.nuxeo.scim.v2.rest.usermanager.ScimV2UserObject

@Produces({"application/scim+json","application/json"})
@Path("/Users")
public class ScimV2UserObject
extends ScimV2BaseUMObject

SCIM 2.0 User object.

Since:

2023.14

Field Summary

Fields

Modifier and Type	Field	Description
protected static final com.unboundid.scim2.server.utils.ResourceTypeDefinition	RESOURCE_TYPE_DEFINITION

Fields inherited from class org.nuxeo.scim.v2.rest.usermanager.ScimV2BaseUMObject

baseURL, mappingService, um, webContext

Constructor Summary

Constructors

Constructor	Description
ScimV2UserObject(WebContext webContext)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	createUser(com.unboundid.scim2.common.types.UserResource user)
jakarta.ws.rs.core.Response	deleteUserResource(String uid)
protected com.unboundid.scim2.common.types.UserResource	doCreateUser(com.unboundid.scim2.common.types.UserResource user)
protected jakarta.ws.rs.core.Response	doDeleteUser(String uid)
protected com.unboundid.scim2.common.types.UserResource	doPatchUser(String uid, com.unboundid.scim2.common.messages.PatchRequest patch)
protected com.unboundid.scim2.common.messages.ListResponse<com.unboundid.scim2.common.ScimResource>	doSearch(ScimV2QueryContext queryCtx)
protected com.unboundid.scim2.common.types.UserResource	doUpdateUser(String uid, com.unboundid.scim2.common.types.UserResource user)
com.unboundid.scim2.common.ScimResource	getUserResource(String uid)
protected com.unboundid.scim2.server.utils.ResourcePreparer<com.unboundid.scim2.common.ScimResource>	newResourcePreparer()
com.unboundid.scim2.common.ScimResource	patchUser(String uid, com.unboundid.scim2.common.messages.PatchRequest patch)
protected com.unboundid.scim2.common.types.UserResource	resolveUserResource(String uid)
com.unboundid.scim2.common.ScimResource	updateUser(String uid, com.unboundid.scim2.common.types.UserResource user)

Methods inherited from class org.nuxeo.scim.v2.rest.usermanager.ScimV2BaseUMObject

checkUpdateGuardPreconditions, getResources, isAPowerUserEditableArtifact

Methods inherited from class java.lang.Object

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

Field Details

RESOURCE_TYPE_DEFINITION

protected static final com.unboundid.scim2.server.utils.ResourceTypeDefinition RESOURCE_TYPE_DEFINITION

Constructor Details

ScimV2UserObject

public ScimV2UserObject(@Context
 WebContext webContext)

Method Details

createUser

@POST
public jakarta.ws.rs.core.Response createUser(com.unboundid.scim2.common.types.UserResource user)
                                       throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

getUserResource

@GET
@Path("{uid}")
public com.unboundid.scim2.common.ScimResource getUserResource(@PathParam("uid")
 String uid)
                                                        throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

updateUser

@PUT
@Path("{uid}")
public com.unboundid.scim2.common.ScimResource updateUser(@PathParam("uid")
 String uid,
 com.unboundid.scim2.common.types.UserResource user)
                                                   throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

patchUser

@PATCH
@Path("{uid}")
public com.unboundid.scim2.common.ScimResource patchUser(@PathParam("uid")
 String uid,
 com.unboundid.scim2.common.messages.PatchRequest patch)
                                                  throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

deleteUserResource

@DELETE
@Path("{uid}")
public jakarta.ws.rs.core.Response deleteUserResource(@PathParam("uid")
 String uid)
                                               throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

doCreateUser

protected com.unboundid.scim2.common.types.UserResource doCreateUser(com.unboundid.scim2.common.types.UserResource user)
                                                              throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

resolveUserResource

protected com.unboundid.scim2.common.types.UserResource resolveUserResource(String uid)
                                                                     throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

doUpdateUser

protected com.unboundid.scim2.common.types.UserResource doUpdateUser(String uid,
 com.unboundid.scim2.common.types.UserResource user)
                                                              throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

doPatchUser

protected com.unboundid.scim2.common.types.UserResource doPatchUser(String uid,
 com.unboundid.scim2.common.messages.PatchRequest patch)
                                                             throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

doDeleteUser

protected jakarta.ws.rs.core.Response doDeleteUser(String uid)
                                            throws com.unboundid.scim2.common.exceptions.ScimException

Throws:

com.unboundid.scim2.common.exceptions.ScimException

doSearch

protected com.unboundid.scim2.common.messages.ListResponse<com.unboundid.scim2.common.ScimResource> doSearch(ScimV2QueryContext queryCtx)
                                                                                                      throws com.unboundid.scim2.common.exceptions.ScimException

Specified by:

doSearch in class ScimV2BaseUMObject

Throws:

com.unboundid.scim2.common.exceptions.ScimException

newResourcePreparer

protected com.unboundid.scim2.server.utils.ResourcePreparer<com.unboundid.scim2.common.ScimResource> newResourcePreparer()
                                                                                                                  throws com.unboundid.scim2.common.exceptions.BadRequestException

Throws:

com.unboundid.scim2.common.exceptions.BadRequestException