Bulk Update Users within Groups
patch
/rest/v16/companies/{companyLoginName}/groups/{groupVarName}/users
This endpoint adds or removes users for a group.
Request
Supported Media Types
- application/json
Path Parameters
-
companyLoginName(required): string
Company login name.
-
groupVarName(required): string
Group variable name.
Root Schema : Patch Operations
Type:
arrayTitle:
Patch OperationsThe array of operations.
Show Source
-
Array of:
object Group User Operation
Title:
Group User Operation
Nested Schema : Group User Operation
Type:
objectTitle:
Show Source
Group User Operation-
op(required):
string
Title:
opAllowed Values:[ "ADD", "REMOVE" ]The operation to be performed. -
path(required):
string
Title:
PathThe login of user. -
value:
object User Details
Title:
User Details
Nested Schema : User Details
Type:
objectTitle:
Show Source
User Details-
login(required):
string
Title:
LoginUser login name.
Response
Supported Media Types
- application/json
Default Response
List of users for a group.
Root Schema : user-collection
Type:
Show Source
object-
items:
array List of users
Title:
List of usersList of users
Nested Schema : user
Type:
Show Source
object-
accessPermissions:
object Access Permissions
Title:
Access PermissionsAccess Permissions of a user -
approvalDelegate:
string
Title:
Approval DelegateApproval Delegate -
billAddress1:
string
Title:
Billing Address 1Billing Address 1 -
billAddress2:
string
Title:
Billing Address 2Billing Address 2 -
billCity:
string
Title:
Billing CityBilling City -
billCompany:
string
Title:
Billing CompanyBilling Company -
billCompany2:
string
Title:
Billing Company 2Billing Company 2 -
billCountry:
string
Title:
Billing CountryBilling Country -
billEmail:
string
Title:
Billing EmailBilling Email -
billFax:
string
Title:
Billing FaxBilling Fax -
billFirstName:
string
Title:
Billing First NameBilling First Name -
billLastName:
string
Title:
Billing Last NameBilling Last Name -
billPhone:
string
Title:
Billing PhoneBilling Phone -
billStateProvince:
string
Title:
Billing StateBilling State -
billZip:
string
Title:
Billing ZipBilling Zip -
company:
object Company details
Title:
Company detailsUser Company details. Applicable only for Users Across Companies -
currency:
object Currency
Title:
CurrencyCurrency preference of user. Value holds currency code -
dateAdded:
string
Title:
Date AddedUser creation date -
dateFormat:
object Date Format
Title:
Date FormatUser preferred date time format -
dateModified:
string
Title:
Date ModifiedUser modified date -
email:
string
Title:
EmailEmail of the user -
enabledForSso:
object Enabled For SSO
Title:
Enabled For SSOEnabled For SSO -
externalSsoId:
string
Title:
External SSO IdExternal SSO Id -
fax:
string
Title:
Fax NumberFax of the user -
firstName:
string
Title:
First NameFirst Name of the user -
groups:
object Groups
Title:
GroupsGroups to which the user belongs -
isAccessAdminPermEnabled:
boolean
Title:
Access Admin Permission EnabledAccess Admin Permission Enabled -
isMobileEnabled:
boolean
Title:
Is Mobile EnabledIs Mobile Enabled -
isNotifyEmail:
boolean
Title:
Is Notification Preference EmailIs notification preference email -
isNotifyFax:
boolean
Title:
Is Notification Preference FaxIs notification preference fax -
isProxyPermEnabled:
boolean
Title:
Proxy Permission EnabledProxy permission enabled -
isSuperUserPermEnabled:
boolean
Title:
Is Superuser Permission EnabledIs Superuser Permission Enabled -
isWebServicesOnly:
boolean
Title:
Web Services OnlyWeb Services Only -
jobTitle:
string
Title:
Job TitleJob Title of the user -
language:
object Language
Title:
LanguageLanguage preference of user. Value holds language code -
lastLogin:
string
Title:
Last Login DateUser last loggedin date -
lastName:
string
Title:
Last NameLast Name of the user -
links:
array Links to the related objects
Title:
Links to the related objectsLinks to the related objects -
login:
string
Title:
Login IdLogin Id of the user -
numberFormat:
object Number Format
Title:
Number FormatPreferred number format of user -
partnerLogin:
string
Title:
Partner LoginPartner Login -
phone:
string
Title:
Phone NumberPhone number of the user -
separateShipAddr:
boolean
Title:
Seperate Ship AddressSeperate Ship Address -
shipAddress1:
string
Title:
Shipping Address 1Shipping Address 1 -
shipAddress2:
string
Title:
Shipping Address 2Shipping Address 2 -
shipCity:
string
Title:
Shipping CityShipping City -
shipCompany:
string
Title:
Shipping CompanyShipping Company -
shipCompany2:
string
Title:
Shipping Company 2Shipping Company 2 -
shipCountry:
string
Title:
Shipping CountryShipping Country -
shipEmail:
string
Title:
Shipping EmailShipping Email -
shipFax:
string
Title:
Shipping FaxShipping Fax -
shipFirstName:
string
Title:
Shipping First NameShipping First Name -
shipLastName:
string
Title:
Shipping Last NameShipping Last Name -
shipPhone:
string
Title:
Shipping PhoneShipping Phone -
shipStateProvince:
string
Title:
Shipping StateShipping State -
shipZip:
string
Title:
Shipping ZipShipping Zip -
status:
object Status
Title:
StatusStatus of the user -
timeZone:
object TimeZone of user
Title:
TimeZone of userUser preferred timezone -
type:
object Type
Title:
TypeType of the user -
units:
object Units
Title:
UnitsUser preferred units
Nested Schema : Access Permissions
Type:
objectTitle:
Access PermissionsAccess Permissions of a user
Show Source
Nested Schema : Company details
Type:
objectTitle:
Company detailsUser Company details. Applicable only for Users Across Companies
Show Source
-
loginName:
string
Title:
Company Login NameCompany Login Name -
name:
string
Title:
Company NameCompany Name
Nested Schema : Currency
Type:
objectTitle:
CurrencyCurrency preference of user. Value holds currency code
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
string
Title:
ValueValue
Nested Schema : Date Format
Type:
objectTitle:
Date FormatUser preferred date time format
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
number
Title:
ValueValue
Nested Schema : Enabled For SSO
Type:
objectTitle:
Enabled For SSOEnabled For SSO
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
string
Title:
ValueValue
Nested Schema : Language
Type:
objectTitle:
LanguageLanguage preference of user. Value holds language code
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
string
Title:
ValueValue
Nested Schema : Links to the related objects
Type:
arrayTitle:
Links to the related objectsLinks to the related objects
Show Source
-
Array of:
object reference links
Title:
reference linksReference links for the Parent, Self, Children and Related as applicable
Nested Schema : Number Format
Type:
objectTitle:
Number FormatPreferred number format of user
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
number
Title:
ValueValue
Nested Schema : Status
Type:
objectTitle:
StatusStatus of the user
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
string
Title:
ValueValue
Nested Schema : TimeZone of user
Type:
objectTitle:
TimeZone of userUser preferred timezone
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
number
Title:
ValueValue
Nested Schema : Type
Type:
objectTitle:
TypeType of the user
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
string
Title:
ValueValue
Nested Schema : Units
Type:
objectTitle:
UnitsUser preferred units
Show Source
-
displayValue:
string
Title:
Display ValueDisplay value. -
value:
number
Title:
ValueValue
Nested Schema : items
Type:
Show Source
array-
Array of:
object Access Permission
Title:
Access PermissionUser access bits information
Nested Schema : Access Permission
Type:
objectTitle:
Access PermissionUser access bits information
Show Source
-
hasAccess:
boolean
Title:
Has AccessBoolean attribute that indicates if a user has access to the restricted entity. -
name:
string
Title:
Restricted Entity NameName of the entity to which access restrictions apply -
type:
string
Title:
TypeType of the restricted entity. Possible values productFamily, supportedProductFamily and dataTableFolder -
variableName:
string
Title:
Restricted Entity Variable NameVariable name of the entity to which access restrictions apply
Nested Schema : items
Type:
Show Source
array-
Array of:
object Group
Title:
GroupUser group information
Nested Schema : Group
Type:
objectTitle:
GroupUser group information
Show Source
-
label:
string
Title:
Group NameGroup name -
type:
string
Title:
Group TypeType of the group -
variableName:
string
Title:
Group Variable NameVariable name of the group
Nested Schema : reference links
Type:
objectTitle:
reference linksReference links for the Parent, Self, Children and Related as applicable
Show Source
-
href:
string
Title:
URL to the related objectURL to the related object -
name:
string
-
rel:
string
Title:
Link Relationship to the current objectDefault Value:selfLink Relationship to the current object
Examples
The following example shows how to update users within groups via one web services request by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Content-type: application/json" -H "Accept: application/json" https://sitename.oracle.com/rest/v16/companies/visionServices/groups/midwestTestGroup/users
Request Body Sample
{
"operations": [{
"op": "remove",
"path": "/superuser"
}, {
"op": "add",
"path": "/",
"value": {
"login": "msmith"
}
}, {
"op": "add",
"path": "/",
"value": {
"login": "ljones"
}
}
]
}
Response Body Sample
{
"items": [{
"login": "amayor",
"firstName": "Alex",
"lastName": "Mayor"
}, {
"login": "msmith",
"firstName": "Mary",
"lastName": "Smith"
}, {
"login": "ljones",
"firstName": "Lisa",
"lastName": "Jones"
}
],
"links": [{
"rel": "canonical",
"href": "https://sitename.oracle.com/rest/v16/companies/_host/groups/midwestTestGroup/users"
}, {
"rel": "self",
"href": "https://sitename.oracle.com/rest/v16/companies/_host/groups/midwestTestGroup/users?offset=0&limit=1000"
}
]
}