Revoke user's skills via the API

It's possible to revoke users' skills via the Learn365 API.

 

NOTE  

We've implemented new Skills endpoints that will eventually replace the corresponding Competency endpoints. You can continue to use the legacy Competency endpoints until we deprecate them as part of the Learn365 (v.3.64) release, which is currently scheduled for Monday, August 18, 2025.

We advise you to start planning for the deprecation of the Competency endpoints and migrating to the new Skills endpoints. This is to ensure that, if you encounter any issues or errors, they can be resolved by the time we deprecate the endpoints.

 

This article describes how to get the ID of a skill via new, as well as legacy endpoints.

 

Revoke a user's skill via the UserSkills endpoint

Before revoking a skill, you’ll need the:

  • courseCatalogId - the ID of the course catalog that contains the skill you want to revoke. You can find this via the API by following the steps in this article.
  • userLoginName of the user whose skill you want to revoke. You can find this via the API by following the steps in this article.
  • skillId and levelId - the ID of the skill and the level you want to revoke. You can find this via the API by following the steps in this article.

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. In the UserSkills section, find the POST services/skills/catalog/{courseCatalogId}/UserSkills/User/{userLoginName}/RevokeSkill endpoint and select Try it out in the top right-hand corner.

3. Enter the courseCatalogId.

4. In the userLoginName field, enter the user@domain.com part of the user's login name.

5. In the request body, enter the:

  • skillId GUID parameter.
  • levelId GUID parameter.

 

revoke skills via API

 

6. Select the Execute button to run the request.

7. Go to the Responses block to check the results:

  • Number 2xx (for example, 200) under Code shows that the request worked correctly.
  • In the Response body field the results of the request will be displayed including the date and time of the skill revocation.
  • The user's skill will be revoked at the level you've specified. The skill will be marked as Revoked in the Learn365 Admin Center > Users > select a learner > View Learner's Transcript > Skills, as well as the learner's My Training Dashboard > Transcript > Skills sections. The learner will also receive a Skill revoked notification.

 

swagger_revoke_user_skills_via_api_userskills_endpoint_results

 

You can check the Audit Trail to see more information about the revoked skill.

8. Go to the Learn365 Admin Center > Global Settings > Audit Trail.

9. Find and select the last record with the Skill was revoked from learner activity name to see more information.

 

audit_trail_skill_revoked_via_api_more_information

 

Revoke a user's skill via API via the Users endpoint (legacy)

1. Go to https://api.365.systems/ and make sure you are authorized with the relevant API key.

2. Find the Users section, expand it, find the POST /odata/v2/Users('{LoginName}')/RevokeCompetency with the Revokes competency (skill) description and then select Try it out in the top right-hand corner.

 

 

3. After you select Try it out, two fields will be displayed. You will need to fill in the required parameters:

  • key: LoginName where you need to enter the login name of the user you want to revoke a skill from.
  • "competencyId": "string" where you need to replace the string with the id of the skill you want to remove from a user.
  • "competencyLevelId": "string" where you need to replace the string with the id of the skill level.

You can find the required competencyId and  competencyLevelId via Learn365 API.

 

2022-07-13_17_37_34-LMS365_API.png

 

4.  Select the Execute button to run the command.

5. Go to the Responses block to check the results:

 

Was this article helpful?
0 out of 1 found this helpful

Comments

Article is closed for comments.