Introducing Enhanced Staff Management APIs for Canvas Credentials

DoraJekkel
Instructure
Instructure
0
244

Canvas.png

Dear Canvas Credentials Community,

At Canvas Credentials, we're dedicated to providing seamless experiences for our users. That's why we're excited to introduce our latest update: Enhanced Staff Management APIs. These new endpoints are designed to streamline issuer operations, making it easier than ever to manage staff members within your organization.

What's New?

We've introduced several new staff-related endpoints:

  • Adding a New Member to Issuer's Staff: POST /v2/issuers/{entity_id}/staff
  • Changing an Existing Member's Role: PUT /v2/issuers/{entity_id}/staff , PATCH /v2/issuers/{entity_id}/staff (works same as PUT endpoint)
  • Removing an Existing Member from Issuer's Staff: DELETE /v2/issuers/{entity_id}/staff/{email}
  • Inviting a New Member to Issuer's Staff: POST /v2/issuers/{entity_id}/staff/invitations

 

Why the Change?

These new endpoints enhance the functionality of managing staff members within Canvas Credentials. By providing dedicated endpoints for staff management tasks, we're simplifying the process and making it more intuitive for administrators and issuers.

What's Next?

Detailed documentation for these new endpoints is available here. We encourage all users to familiarize themselves with these changes and update their workflows accordingly.

Please note that the current endpoint PUT /v2/issuers/{entity_id} will continue to provide staff data as a readonly property. Operations such as adding new members, changing their roles, or removing existing members will be limited to the new endpoints. After a grace period of one month, this endpoint will be updated to integrate these enhancements.

Embrace the Future of Staff Management

With our Enhanced Staff Management APIs, we're paving the way for smoother and more efficient issuer operations. We're excited about the opportunities these updates present and remain committed to delivering a best-in-class experience for all our users.

Stay tuned for more updates, and as always, thank you for choosing Canvas Credentials!

 

Sincerely,

The Canvas Credentials Team