Versions Compared

Key

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

General Information

...

ServiceAPIMethod
urac/admin/group/addUsersPOST


Data Model: %Link to Data Model% Groups

Workflow: %Link to Architecture Page% Add Users To Group Flow

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
 
codeBodyYESStringN/A
 

...

defined in the form as groupCode
usersBodyNOArrayN/Aarray of usernames


Output

...

Valid Response

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

...

true
}


Invalid Response

Code Block
languagejs
titleError Response Sample
{
    "result":false,
    "errors":{
        "codes":[400],
        "details":[
            {
                "code":400,
                "message":"ProblemDatabase with the provided passwordconnection error"
            }
        ]
    }
}



Error Codes



 

Code
Description
400Database
Error
connection error


Example (CURL)

...

Request

Code Block
languagebash
titleCalling YOUR Add Users API
 > CURL -X POST http://127.0.0.1:4000/.../urac/admin/group/addUsers -d 'groupCode=bronze&users[]=user1&users[]=user2' 

Response

Code Block
languagejs
titleYOUR Add Users API response
{
	"result": true,
	"data": {
		"_id": "57063608622c47b5c097d19b",
		"..."
	}true
}