General Information

Service	API	Method	Data Models	Workflow
urac	/admin/user/pin	PUT	Users

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

Name

Source

Mandatory

Type

Special Format

Description

user

Body

YES

Object

Includes one of id, username, or email

User Object

One of the following should exist under the user object:

Name	Mandatory	Type	Special Format	Description
id	YES	String	N/A	User ID
username	YES	String	N/A	Username
email	YES	String	N/A	User Email

pin

Body

YES

Object

One of delete or reset with allowed

Pin 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
602	Model error: + %model_error%

Browser not supported