PUT - /admin/user/pin

General Information


ServiceAPIMethodData ModelsWorkflow
urac/admin/user/pinPUTUsers

Description

This API edits, resets, or deletes the pin information of a user that has a username, email, or id that matches the one sent in the user object in the request body.

Input


Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
userBodyYESObjectIncludes one of id, username, or emailUser Object

One of the following should exist under the user object:

NameMandatoryTypeSpecial FormatDescription
idYESStringN/AUser ID
usernameYESStringN/AUsername
emailYESStringN/AUser Email
pinBodyYESObjectOne of delete or reset with allowedPin Object

One of the following should exist under the pin object:

Pin Object
pin: {
	delete: boolean

	OR: 

	reset: boolean,
	allowed: boolean

	OR: 

	reset: boolean
}

Output


Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Valid Response Sample
{ 
  result: true,
  data: true
}
or, in case nothing changed 
{ 
  result: true,
  data: false
}

Invalid Response

Error Response Sample
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes


Code
Description
400

Business logic required data are missing

520

Unable to find user

525

Unable to generate pin at this time

602Model error: + %model_error%