Document toolboxDocument toolbox

unrollEndUser

Owned by Frode Nilsen (Unlicensed)
Last updated: 11 Jun 2018Version comment
1 min read
URLhttps://<xid-useradm-baseurl>/<pid>
Request

DELETE with URL path parameter pid (same as bankid_altsub) for user in question

AuthenticationAccess Token as Bearer Token in Authorization Header
Success response204 No Content regardless of pid is enrolled or not
Response
204No ContentUser with pid is unrolled regardless of if it was previously enrolled or not
403ForbiddenBearer token is not accepted for any reason
400Bad Request The pid is not an xID user or resource access is insufficient (missing scope)

Error responses contains further information on the reason according to standard.

ExampleSee below

This method unrolls from the xID service any previously enrolled end user given by pid. There is no dialog shown to the end user. 

Note: The end user is not permanently deleted. Data is is retained for one month to simplify re-enrolment of the end user in this grace period. 

Example

zzz