Package org.nuxeo.scim.v2.api

Interface ScimV2MappingService

All Known Implementing Classes:
ScimV2MappingServiceImpl
public interface ScimV2MappingService
Since:
2023.14

  • Method Details

    • createNuxeoGroupFromGroupResource

      DocumentModel createNuxeoGroupFromGroupResource(com.unboundid.scim2.common.types.GroupResource group) throws com.unboundid.scim2.common.exceptions.ScimException
      Creates a Nuxeo group model according to the group resource.
      Parameters:
      group - the group resource
      Returns:
      the created group
      Throws:
      com.unboundid.scim2.common.exceptions.ScimException - if an error occurred

    • createNuxeoUserFromUserResource

      DocumentModel createNuxeoUserFromUserResource(com.unboundid.scim2.common.types.UserResource user) throws com.unboundid.scim2.common.exceptions.ScimException
      Creates a Nuxeo user model according to the user resource.
      Parameters:
      user - the user resource
      Returns:
      the created user
      Throws:
      com.unboundid.scim2.common.exceptions.ScimException - if an error occurred

    • getGroupResourceFromNuxeoGroup

      com.unboundid.scim2.common.types.GroupResource getGroupResourceFromNuxeoGroup(DocumentModel groupModel, String baseURL) throws com.unboundid.scim2.common.exceptions.ScimException
      Gets a group resource representation of a group model.
      Parameters:
      groupModel - the group model
      baseURL - the location base URL of the SCIM group object
      Returns:
      the group resource
      Throws:
      com.unboundid.scim2.common.exceptions.ScimException - if an error occurred

    • getMapping

      ScimV2Mapping getMapping()
      Gets the contributed SCIM mapping.
      Returns:
      the contributed scim mapping

    • getUserResourceFromNuxeoUser

      com.unboundid.scim2.common.types.UserResource getUserResourceFromNuxeoUser(DocumentModel userModel, String baseURL) throws com.unboundid.scim2.common.exceptions.ScimException
      Gets a user resource representation of a user model.
      Parameters:
      userModel - the user model
      baseURL - the location base URL of the SCIM user object
      Returns:
      the user resource
      Throws:
      com.unboundid.scim2.common.exceptions.ScimException - if an error occurred

    • patchNuxeoGroup

      void patchNuxeoGroup(String uid, com.unboundid.scim2.common.messages.PatchRequest patch) throws com.unboundid.scim2.common.exceptions.ScimException
      Patches a Nuxeo group model according to the patch request.
      Parameters:
      uid - the group uid
      patch - the patch request
      Throws:
      com.unboundid.scim2.common.exceptions.ScimException - if an error occurred

    • patchNuxeoUser

      DocumentModel patchNuxeoUser(String uid, com.unboundid.scim2.common.messages.PatchRequest patch) throws com.unboundid.scim2.common.exceptions.ScimException
      Patches a Nuxeo user model according to the patch request.
      Parameters:
      uid - the user uid
      patch - the patch request
      Returns:
      the patched user
      Throws:
      com.unboundid.scim2.common.exceptions.ScimException - if an error occurred

    • queryGroups

      com.unboundid.scim2.common.messages.ListResponse<com.unboundid.scim2.common.ScimResource> queryGroups(ScimV2QueryContext queryCtx) throws com.unboundid.scim2.common.exceptions.ScimException
      Searches for groups.
      Parameters:
      queryCtx - the query context
      Returns:
      the query result
      Throws:
      com.unboundid.scim2.common.exceptions.ScimException - if an error occurred

    • queryUsers

      com.unboundid.scim2.common.messages.ListResponse<com.unboundid.scim2.common.ScimResource> queryUsers(ScimV2QueryContext queryCtx) throws com.unboundid.scim2.common.exceptions.ScimException
      Searches for users.
      Parameters:
      queryCtx - the query context
      Returns:
      the query result
      Throws:
      com.unboundid.scim2.common.exceptions.ScimException - if an error occurred

    • updateNuxeoGroupFromGroupResource

      DocumentModel updateNuxeoGroupFromGroupResource(String uid, com.unboundid.scim2.common.types.GroupResource group) throws com.unboundid.scim2.common.exceptions.ScimException
      Updates a Nuxeo group model according to the group resource.
      Parameters:
      uid - the group uid
      group - the group resource
      Returns:
      the updated group
      Throws:
      com.unboundid.scim2.common.exceptions.ScimException - if an error occurred

    • updateNuxeoUserFromUserResource

      DocumentModel updateNuxeoUserFromUserResource(String uid, com.unboundid.scim2.common.types.UserResource user) throws com.unboundid.scim2.common.exceptions.ScimException
      Updates a Nuxeo user model according to the user resource.
      Parameters:
      uid - the user uid
      user - the user resource
      Returns:
      the updated user
      Throws:
      com.unboundid.scim2.common.exceptions.ScimException - if an error occurred