Package org.apache.directory.scim.protocol

Interface SelfResource

All Known Implementing Classes:

SelfResourceImpl

@Path("Me")
public interface SelfResource

From SCIM Protocol Specification, section 3, page 9

Author:

chrisharm

See Also:

• Scim spec section 3.2 Resource Endpoint Operations Description -------- ---------------- ---------------------- -------------------- Self /Me GET, POST, PUT, PATCH, Alias for operations DELETE (Section 3.11) against a resource mapped to an authenticated subject (e.g., User).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH

Method Summary

Modifier and Type	Method	Description
default jakarta.ws.rs.core.Response	create(ScimUser resource, AttributeReferenceListWrapper attributes, AttributeReferenceListWrapper excludedAttributes)
default jakarta.ws.rs.core.Response	delete()
default jakarta.ws.rs.core.Response	getSelf(AttributeReferenceListWrapper attributes, AttributeReferenceListWrapper excludedAttributes)
default jakarta.ws.rs.core.Response	patch(PatchRequest patchRequest, AttributeReferenceListWrapper attributes, AttributeReferenceListWrapper excludedAttributes)
default jakarta.ws.rs.core.Response	update(ScimUser resource, AttributeReferenceListWrapper attributes, AttributeReferenceListWrapper excludedAttributes)

Field Details

PATH

static final String PATH

See Also:

• Constant Field Values

Method Details

getSelf

@GET
@Produces({"application/scim+json","application/json"})
default jakarta.ws.rs.core.Response getSelf(@QueryParam("attributes")
 AttributeReferenceListWrapper attributes,
 @QueryParam("excludedAttributes")
 AttributeReferenceListWrapper excludedAttributes)
                                     throws ScimException,
ResourceException

Returns:

Throws:

UnableToRetrieveResourceException

ScimException

ResourceException

See Also:

• Scim spec, retrieving known resources

create

@POST
@Consumes({"application/scim+json","application/json"})
@Produces({"application/scim+json","application/json"})
default jakarta.ws.rs.core.Response create(ScimUser resource,
 @QueryParam("attributes")
 AttributeReferenceListWrapper attributes,
 @QueryParam("excludedAttributes")
 AttributeReferenceListWrapper excludedAttributes)
                                    throws ScimException,
ResourceException

Returns:

Throws:

ScimException

ResourceException

See Also:

• Scim spec, query resources

update

@PUT
@Consumes({"application/scim+json","application/json"})
@Produces({"application/scim+json","application/json"})
default jakarta.ws.rs.core.Response update(ScimUser resource,
 @QueryParam("attributes")
 AttributeReferenceListWrapper attributes,
 @QueryParam("excludedAttributes")
 AttributeReferenceListWrapper excludedAttributes)
                                    throws ScimException,
ResourceException

Returns:

Throws:

ScimException

ResourceException

See Also:

• Scim spec, update

patch

@PATCH
@Consumes({"application/scim+json","application/json"})
@Produces({"application/scim+json","application/json"})
default jakarta.ws.rs.core.Response patch(PatchRequest patchRequest,
 @QueryParam("attributes")
 AttributeReferenceListWrapper attributes,
 @QueryParam("excludedAttributes")
 AttributeReferenceListWrapper excludedAttributes)
                                   throws ScimException,
ResourceException

Throws:

ScimException

ResourceException

delete

@DELETE
default jakarta.ws.rs.core.Response delete()
                                    throws ScimException,
ResourceException

Throws:

ScimException

ResourceException