Function: replaceGroup()

function replaceGroup(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  displayName?: string;
  externalId?: string;
  id?: string;
  members?: object[];
  meta?: {
   [key: string]: unknown;
     created?: Date;
     lastModified?: Date;
     location?: string;
     resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY";
  };
  schemas?: string[];
}>;

Defined in: src/userProvisioning/api/groups.ts:24

Updates the details of a group with its unique ID.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ directoryId: string; displayName?: string; externalId?: string; id: string; members?: object[]; meta?: { created?: unknown; lastModified?: unknown; location?: string; resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY"; }; schemas?: string[]; }	-
parameters.directoryId	string	The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.
parameters.displayName?	string	Group display name. This is a immutable, required, and read-only field.
parameters.externalId?	string	Identifier defined by provisioning client. CaseExact. Uniqueness is controlled by client.
parameters.id?	string	Unique SCIM id that serves as reference to the group. Use the [Get groups API] (https://developer.atlassian.com/cloud/admin/user-provisioning/rest/api-group-groups/#api-scim-directory-directoryid-groups-get) to get the SCIM id.
parameters.members?	object[]	Group members
parameters.meta?	{ created?: unknown; lastModified?: unknown; location?: string; resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY"; }	Group metadata information.
parameters.meta.created?	unknown	The DateTime that the resource was added to Atlassian SCIM service. This is a read-only field.
parameters.meta.lastModified?	unknown	The most recent DateTime that the details of this resource were updated. This is a read-only field.
parameters.meta.location?	string	The URI of the resource being returned. This is a read-only field.
parameters.meta.resourceType?	string & object | "USER" | "GROUP" | "DIRECTORY"	The name of the resource type of the resource. This is a read-only and case-sensitive field.
parameters.schemas?	string[]	SCIM schemas that define the attributes present in the current JSON structure. This ia a required field during user creation or modification.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; displayName?: string; externalId?: string; id?: string; members?: object[]; meta?: { [key: string]: unknown; created?: Date; lastModified?: Date; location?: string; resourceType?: string & object | "USER" | "GROUP" | "DIRECTORY"; }; schemas?: string[]; }>