Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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
idNOYESStringN/AUser ID
usernameNOYESStringN/AUsername
emailNOYESStringN/AUser Email


pinBodyYESObjectOne of delete or reset with allowedPin Object

One of the following should exist under the pin object:

Code Block
titlePin Object
linenumberstrue
collapsetrue
pin: {
	delete: boolean

	OR: 

	reset: boolean,
	allowed: boolean
}


...