Security API : Security Controller

The Security APIs are used to view and maintain the assigned security options for a variety of objects.

For more detailed information, see the Security API Endpoints section below or the EnterWorks Swagger pages.

Security API Endpoints

GET /api/groupSecurity:

  • Retrieves the Group Security for an Object Type based on the specified Object ID (objectId).

GET /api/objSecurities:

  • Retrieves information for the following objects:

    Note: This is also the list of valid entries for the objEntityName parameter:

    • User

    • Group

    • Data Sources

    • Sequence

    • Profile

    • Codeset

    • Hierarchy

    • Taxonomy

    • Transmission Option

    • Attribute Security Filter

    • Record Security Filter

    • File Definition

    • Repository

    • Repository Folder

    • Export Template

PATCH /api/objSecurities:

  • Updates the object security mappings for a specific object.

DELETE /api/profiles/attrSecurityFilters/{id}:

  • Removes the attribute security mappings filter from the specified security filter (id).

GET /api/profiles/{profileId}/attrSecurityFilters:

  • Retrieves the attribute security mappings for the specified attribute security filter (profileId).

PATCH /api/profiles/{profileId}/attrSecurityFilters/mappings:

  • Updates the security mapping attributes for a specific profile (profileId).

  • All mappings must be passed using the wrapper and any mappings not included in the list will be removed.

  • The attribute security filter mapping IDs will be changed after the call.

    Note: This is a PUT operation, not a PATCH.

POST /api/profiles/{profileId}/attrSecurityFilters/mappings:

  • Creates an attribute security filter and attribute security filter mappings for the specified profile (profileId).

GET /api/profiles/{profileId}/attrSecurityFilters/{id}:

  • Retrieves the attribute security mappings for the specified attribute security filter (id).

GET /api/repositories/{repositoryId}/attrSecurityMappings:

  • Retrieves the attribute security mappings for the user currently logged in to the specified repository (repositoryId).

POST /api/updateGroupSecurity:

  • Updates the security settings for the specified Group ID.

GET /api/userObjSec:

  • Retrieves security settings for a specified object (objectId) or object type (objectType).