Function replaceUser

Parameters

• client: Client
• parameters: {
      active?: boolean;
      attributes?: string;
      department?: string;
      directoryId: string;
      displayName?: string;
      emails?: {
          primary?: boolean;
          type?: string;
          value?: string;
          [key: string]: unknown;
      }[];
      excludedAttributes?: string;
      externalId?: string;
      groups?: {
          $ref?: string;
          display?: string;
          type?: string;
          value?: string;
          [key: string]: unknown;
      }[];
      id?: string;
      meta?: {
          created?: unknown;
          lastModified?: unknown;
          location?: string;
          resourceType?: string & {}
          | "USER"
          | "GROUP"
          | "DIRECTORY";
          [key: string]: unknown;
      };
      name?: {
          familyName?: string;
          formatted?: string;
          givenName?: string;
          honorificPrefix?: string;
          honorificSuffix?: string;
          middleName?: string;
          [key: string]: unknown;
      };
      nickName?: string;
      organization?: string;
      phoneNumbers?: {
          primary?: boolean;
          type?: string;
          value?: string;
          [key: string]: unknown;
      }[];
      preferredLanguage?: string;
      schemas?: string[];
      timezone?: string;
      title?: string;
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"?: {
          department?: string;
          organization?: string;
          [key: string]: unknown;
      };
      "urn:scim:schemas:extension:atlassian-external:1.0"?: {
          atlassianAccountId?: string;
          [key: string]: unknown;
      };
      userId: string;
      userName?: string;
  }

  • Optionalactive?: boolean

    A boolean value indicating the user's administrative status. This value will default to true if not provided.

  • Optionalattributes?: string

    Resource attributes to be included in the response. Mutually exclusive from excludedAttributes. Example: userName,emails.value

  • Optionaldepartment?: string

    User's department.

  • directoryId: string

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

  • OptionaldisplayName?: string

    User's display name.

  • Optionalemails?: { primary?: boolean; type?: string; value?: string; [key: string]: unknown }[]

    Email addresses of the User. This is a required field during user creation or modification. One value must be marked as primary.

  • OptionalexcludedAttributes?: string

    Resource attributes to be excluded in the response. Mutually exclusive from attributes. Example: timezone,emails.type,department

  • OptionalexternalId?: string

    Identifier defined by provisioning client. This is a case-sensitive field. Uniqueness is controlled by client.

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

    Groups to which the user is associated in SCIM.

  • Optionalid?: string

    Unique identifier defined by Atlassian SCIM Service. CaseExact. This is a read-only field and will be disregarded if included in the payload during user creation or modification..

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

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

  • Optionalname?: {
        familyName?: string;
        formatted?: string;
        givenName?: string;
        honorificPrefix?: string;
        honorificSuffix?: string;
        middleName?: string;
        [key: string]: unknown;
    }

    • OptionalfamilyName?: string

      The family name of the User.

    • Optionalformatted?: string

      The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.

    • OptionalgivenName?: string

      The given name of the User.

    • OptionalhonorificPrefix?: string

      The honorific prefix(es) of the User, or title in most Western languages.

    • OptionalhonorificSuffix?: string

      The honorific suffix(es) of the User, or suffix in most Western languages.

    • OptionalmiddleName?: string

      The middle name(s) of the User.

  • OptionalnickName?: string

    User's nickname.

  • Optionalorganization?: string

    User's organization.

  • OptionalphoneNumbers?: { primary?: boolean; type?: string; value?: string; [key: string]: unknown }[]

    Phone numbers of the user.

  • OptionalpreferredLanguage?: string

    User's preferred language.

  • Optionalschemas?: string[]

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

  • Optionaltimezone?: string

    User's timezone. e.g. America/Los_Angeles .

  • Optionaltitle?: string

    User's title.

  • Optionalurn:ietf:params:scim:schemas:extension:enterprise:2.0:User?: { department?: string; organization?: string; [key: string]: unknown }

    • Optionaldepartment?: string

      Department the user belongs to.

    • Optionalorganization?: string

      Organization the user belongs to.

  • Optionalurn:scim:schemas:extension:atlassian-external:1.0?: { atlassianAccountId?: string; [key: string]: unknown }

  • userId: string

    Unique ID to identiy the users. Use the Get users API to get the userId.

  • OptionaluserName?: string

    Unique identifier defined by the provisioning client. Atlassian SCIM service will verify the value and guarantee its uniqueness. This is a required field during user creation or modification.

• Optionaloptions: RequestOptions