lock

<< Click to Display Table of Contents >>

Navigation:  API > users >

lock

Description

Locks out a user, preventing them from being able to access their account (see unlock).

Syntax

https://api.cameyo.com/users/lock?clientId=...&clientSecret=...&user=user@company.com

Required parameters

user: username (email).

Return

200: success.

400: invalid parameters.

403: authentication failed or insufficient permissions.

404: user not found.

500: an internal error has occurred.

Response examples:

 {"success":true,"code":200}

 {"success":false,"code":404,"message":"User not found"}