jira.js
    Preparing search index...

    Function patchUser

    • Updates a user's information in the directory based on their userId via PATCH. Refer to Service Provider Configuration APIs for details on supported operations.

      Parameters

      • client: Client
      • parameters: {
            attributes?: string;
            directoryId: string;
            excludedAttributes?: string;
            operations?: {
                op?: string;
                path?: string;
                value?: unknown;
                [key: string]: unknown;
            }[];
            schemas?: string[];
            userId: string;
        }
        • Optionalattributes?: string

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

        • directoryId: string

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

        • OptionalexcludedAttributes?: string

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

        • Optionaloperations?: { op?: string; path?: string; value?: unknown; [key: string]: unknown }[]

          SCIM patch operations.

        • Optionalschemas?: string[]

          SCIM patch schemas.

        • userId: string

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

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              active?: boolean;
              department?: string;
              displayName?: string;
              emails?: {
                  primary?: boolean;
                  type?: string;
                  value?: string;
                  [key: string]: unknown;
              }[];
              externalId?: string;
              groups?: {
                  $ref?: string;
                  display?: string;
                  type?: string;
                  value?: string;
                  [key: string]: unknown;
              }[];
              id?: string;
              meta?: {
                  created?: Date;
                  lastModified?: Date;
                  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;
              };
              userName?: string;
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility