Edit User Groups

General Information

Service	API	Method	Data Models	Workflow
urac	/admin/user/groups	PUT	Users & 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.

If the key belongs to main tenant then the groups array @ the root level will be modified

If the key belongs to sub tenant then the groups array @ allowedTenants level will be modified

Input

Type: application/json

Name

Source

Mandatory

Type

Special Format

Description

user

Body

YES

Object

Includes one of id, username, or email

User Object

One of the following should exist under the user object:

Name	Mandatory	Type	Special Format	Description
id	NO	String	N/A	User ID
username	NO	String	N/A	Username
email	NO	String	N/A	User Email

groups

Body

YES

Array

Array of Strings

User 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
602	Model error: + %model_error%

Edit User Groups

[data-colorid=onyh9xoukf]{color:#091e42} html[data-color-mode=dark] [data-colorid=onyh9xoukf]{color:#bdd2f6}General Information

Description

Input

Output

Response

Valid Response

Invalid Response

Response schema

SOAJS Error Codes

0 Comments

General Information