jira.js
    Preparing search index...

    Function addUserToGroup

    • Add a user to a group. This gives the user the same app access and permissions as the group. The user must be in the same directory as the group.

      Note: Adding a user to the org-admin group through this API will return an error after the Units rollout. The org-admin group will no longer grant organization admin access after the rollout. To grant organization admin, use the Assign organization-level role endpoint instead. This applies to all organizations, not just unit organizations.

      You can’t add a user to a group synced from an identity provider. Manage this group in your identity provider instead.

      You can’t add a user to a group if you’ve exceeded your user limit for an app that the group grants access to. Increase your user limit or suspend another user from the app first.

      Parameters

      • client: Client
      • parameters: { accountId: string; directoryId: string; groupId: string; orgId: string }
        • accountId: string

          Every user has a unique ID. Find a user’s account ID by using the Get users endpoint.

        • directoryId: string

          A directory has a unique ID. Use the Get directories endpoint to find the directory ID.

        • groupId: string

          A group has a unique ID. Use the Get groups endpoint to find the group ID.

        • orgId: string

          Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.

      • Optionaloptions: RequestOptions

      Returns Promise<void>