Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/admin/changeUserStatusGET


Data Model: Users

Workflow: Change User Status Flow

Input

...

NameSourceMandatoryTypeSpecial FormatDescription
uIdQueryYESStringN/Athe user id
statusQueryYESStringN/Arestricted to either 'active' OR 'inactive'

 

Output

...

Valid Response

Code Block
languagejs
titleValid Response Sample
{
	"result": true,
	"data": true
}

...

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[405],
        "details":[
            {
                "code":405,
                "message":"Unable to find User. Please try again."
            }
        ]
    }
}



Error Codes


 

Code
Description
405Unable to find User. Please try again.
407Problem validating Request. Please try again.
411invalid user id provided


Example (CURL)

...

Request

Code Block
languagebash
titleCalling Change User Status API
 > CURL -X GET http://127.0.0.1:4000/urac/admin/changeUserStatus?uId=123&status=active

...