Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

General Information

ServiceAPIMethodData ModelsWorkflow
urac/admin/user/groupsPUTUsers & Groups

Description

This API edits the groups of a user that has an id, username, or email 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
idNOStringN/AUser ID
usernameNOStringN/AUsername
emailNOStringN/AUser Email
groupsBodyYESArrayArray of StringsUser Groups


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: 1
}

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

602Model error: + %model_error%
  • No labels