Function replaceGroup

Parameters

• client: Client
• parameters: {
      directoryId: string;
      displayName?: string;
      externalId?: string;
      id: string;
      members?: {
          $ref?: string;
          display?: string;
          type?: string;
          value?: string;
          [key: string]: unknown;
      }[];
      meta?: {
          created?: unknown;
          lastModified?: unknown;
          location?: string;
          resourceType?: string & {}
          | "USER"
          | "GROUP"
          | "DIRECTORY";
          [key: string]: unknown;
      };
      schemas?: string[];
  }

  • directoryId: string

    The SCIM base URL that is generated when conecting an identity provider with SCIM provisioning.

  • OptionaldisplayName?: string

    Group display name. This is a immutable, required, and read-only field.

  • OptionalexternalId?: string

    Identifier defined by provisioning client. CaseExact. Uniqueness is controlled by client.

  • 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.

  • Optionalmembers?: {
        $ref?: string;
        display?: string;
        type?: string;
        value?: string;
        [key: string]: unknown;
    }[]

    Group members

  • Optionalmeta?: {
        created?: unknown;
        lastModified?: unknown;
        location?: string;
        resourceType?: string & {} | "USER" | "GROUP" | "DIRECTORY";
        [key: string]: unknown;
    }

    Group metadata information.

    • Optionalcreated?: unknown

      The DateTime that the resource was added to Atlassian SCIM service. This is a read-only field.

    • OptionallastModified?: unknown

      The most recent DateTime that the details of this resource were updated. This is a read-only field.

    • Optionallocation?: string

      The URI of the resource being returned. This is a read-only field.

    • OptionalresourceType?: string & {} | "USER" | "GROUP" | "DIRECTORY"

      The name of the resource type of the resource. This is a read-only and case-sensitive field.

  • Optionalschemas?: string[]

    SCIM schemas that define the attributes present in the current JSON structure. This ia a required field during user creation or modification.

• Optionaloptions: RequestOptions