User

Users are collaborators with a Yousign app license. They are able to send Signature Requests, save Contacts, and use Templates and forms from the Yousign app. Their access rights depend on their role and the workspaces they are attached to.

As of today, Users can be fully managed from the app (invite a new User, delete invitation, etc.), and only partially from the API.
See this article for more details on Users management from the app.

📘

Sandbox VS Production environment

In the Sandbox environment, users can only be read, but not created or modified.

The following endpoints are accessible in both Sandbox and Production environments:

• List Users: GET /users
• Get a User: GET /users/{userId}

The following endpoints are only available in Production environment:

• Update a User: PATCH /users/{userId}

Read Users

List all the Users in your organization with the GET /users endpoint.

Retrieve a specific User by providing a User ID with the GET /users/{userId} endpoint.

Edit Users

With the PATCH /users/{userId} endpoint, you can:

• Change a User’s role from admin to member or from member to admin with the role parameter.
  Note that you cannot change the role of a suspended user.
• Activate or suspend a User with the active parameter.

📖

Restrictions on owners

The following cannot be done via API:

• Change the role of a user with the owner role.
• Assign the owner role to another user.
• Suspend a user with the owner role.

Please contact our customer support if you want to request a change of owner.