latestOpenAPI 3.0.12026-08-1091181421.2 KB

44eb39b4bd65

Assertions

Revoke multiple Assertions

post/v2/assertions/revoke

Request body

codestring nullable

Error code if assertion could not be revoked

entityIdstring nullable

Entity ID of the Assertion to revoke

idstring nullable

ID of the Assertion to revoke

reasonstring nullable

Error reason if assertion could not be revoked

revocationReasonstring required

Short description of why the Assertion is being revoked

revokedboolean nullable

Example request

[
  {
    "entityId": "i9CirfwJTuSfiqg0FFUBdQ",
    "id": "62aa04adf5afe00d0a6dac72",
    "revocationReason": "Course was cancelled"
  }
]

Response

OK

codestring nullable

Error code if assertion could not be revoked

entityIdstring nullable

Entity ID of the Assertion to revoke

idstring nullable

ID of the Assertion to revoke

reasonstring nullable

Error reason if assertion could not be revoked

revocationReasonstring required

Short description of why the Assertion is being revoked

revokedboolean nullable

Example response

[
  {
    "entityId": "i9CirfwJTuSfiqg0FFUBdQ",
    "id": "62aa04adf5afe00d0a6dac72",
    "revocationReason": "Course was cancelled"
  }
]