Versions Compared

Version Old Version 1 New Version 2
Changes made by

peter eid

peter eid

Saved on

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%

...

  
NameSourceMandatoryTypeSpecial FormatDescription
tIdBody or QueryYESStringN/AThe Tenant ID
codeBodyYESStringN/Adefined in the form as groupCode
usersBodyfalseArrayN/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":[400600],
        "details":[
            {
                "code":400600,
                "message":"Problem with the provided password"
            }
        ]
    }
}



Error Codes

 

Code
Description
400600Database Errorconnection 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
}