Managing users

This REST API is used to manage users and user groups. You can view, add, update, and delete users and their details.

List of resources

  • POST /login

    Signs in to Developer Portal with the provided credentials. This API supports the Native or LDAP users login only.

  • POST /forgotpassword

    Allows to recover a forgotten password via the registered email.

  • POST /resetpassword

    Allows to reset your password via the registered email.

  • GET /passwordpolicy

    Retrieves the details configured password policy.

  • POST /signup

    Allows to sign up to Developer Portal.

  • PUT /users/updatepassword

    Updates the password with the provided value.

  • PUT /users/updateemail

    Updates the email with the provided value.

  • PUT /users/updatepicture

    Updates the profile picture with the provided image.

  • GET /users

    Retrieves the list of users.

  • POST /users

    Creates a new user with the given details.

  • PUT /users/anonymize

    Anonymizes the specified user accounts that are deleted.

  • GET /users/self

    Retrieves the details of the currently signed in user.

  • GET /users/self/privileges

    Retrieves the privileges of the currently signed in user.

  • GET /users/{id}

    Retrieves the details of specified user.

  • PUT /users/{id}

    Updates the user name such as the first name, last name, email of specific user.

  • DELETE /users/{id}

    Deletes the specified user.

  • POST /users/delete

    Deletes the account of current user.

  • GET /groups/{id}/users

    Retrieves the users of the specified group.

  • PUT /groups/{id}/users

    Updates the users of the specified group with the given details.

  • DELETE /groups/{id}/users

    Deletes the given users of the specified group.

  • GET /groups

    Retrieves the list of groups.

  • POST /groups

    Creates a group with the given details.

  • GET /groups/{id}

    Retrieves the details of the specified group.

  • POST /groups/{id}

    Updates the specified group with the given details.

  • DELETE /groups/{id}

    Deletes the specific group.

Sample cURL Command

curl --location --request GET 'developer_portal_rest_base/users/' \
--header 'Authorization: Basic basic_auth'

The users.yaml file is located at SAGInstallDir\DeveloperPortal\developers\openapis.