ArcGIS REST JS
ArcGIS REST API JavaScript Client

addGroupUsers

Function 
import { addGroupUsers } from "@esri/arcgis-rest-portal";
//
addGroupUsers({
  id: groupId,
  users: ["username1", "username2"],
  admins: ["username3"],
  authentication
})
.then(response);

Add users to a group. See the REST Documentation for more information.

Parameters

Parameter Type Default Notes
requestOptions Required IAddGroupUsersOptions

Options for the request

Available requestOptions

Property Type Notes
id string

Group ID
admins Optional string[] | string

An array of usernames to be added to the group as group admins
users Optional string[] | string

An array of usernames to be added to the group as group members
authentication Optional Inherited IAuthenticationManager

The instance of IAuthenticationManager to use to authenticate this request.
credentials Optional Inherited RequestCredentials

A string indicating whether credentials (cookies) will be sent with the request. Used internally for authentication workflows.
fetch Optional Inherited function(input: RequestInfo, init: RequestInit) : Promise<Response>

The implementation of fetch to use. Defaults to a global fetch.
headers Optional Inherited [key: string]: any

Additional Headers to pass into the request.
hideToken Optional Inherited boolean

Prevents the token from being passed in a URL Query param that is saved in browser history. Instead, the token will be passed in POST request body or through X-Esri-Authorization header. NOTE: This will force POST requests in browsers since auth header is not yet supported by preflight OPTIONS check with CORS.
httpMethod Optional Inherited HTTPMethods

The HTTP method to send the request with.
maxUrlLength Optional Inherited number

If the length of a GET request's URL exceeds maxUrlLength the request will use POST instead.
params Optional Inherited IParams

Additional parameters to pass in the request.
portal Optional Inherited string

Base url for the portal you want to make the request to. Defaults to authentication.portal if authentication exists, otherwise to 'https://www.arcgis.com/sharing/rest'.
rawResponse Optional Inherited boolean

Return the raw response

Returns

A Promise

Promise<IAddGroupUsersResult>
Property Type Notes
errors Optional ArcGISRequestError[] | ArcGISRequestError

An array of request errors
notAdded Optional string[] | string

An array of usernames that were not added
Function defined in packages/arcgis-rest-portal/src/groups/add-users.ts:56