/** * The Jira Cloud platform REST API * Jira Cloud platform REST API documentation * * The version of the OpenAPI document: 1001.0.0-SNAPSHOT * Contact: ecosystem@atlassian.com * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import { ColumnItem, GroupName, PageBeanUser, UnrestrictedUserEmail, User, UserMigrationBean } from '../models'; export interface BulkGetUsersRequest { accountId: Array; startAt?: number; maxResults?: number; username?: Array; key?: Array; } export interface BulkGetUsersMigrationRequest { startAt?: number; maxResults?: number; username?: Array; key?: Array; } export interface CreateUserRequest { request_body: { [key: string]: object; }; } export interface GetAllUsersRequest { startAt?: number; maxResults?: number; } export interface GetUserRequest { accountId?: string; username?: string; key?: string; expand?: string; } export interface GetUserDefaultColumnsRequest { accountId?: string; username?: string; } export interface GetUserEmailRequest { accountId: string; } export interface GetUserEmailBulkRequest { accountId: Array; } export interface GetUserGroupsRequest { accountId: string; username?: string; key?: string; } export interface RemoveUserRequest { accountId: string; username?: string; key?: string; } export interface ResetUserColumnsRequest { accountId?: string; username?: string; } export interface SetUserColumnsRequest { accountId?: string; } /** * no description */ export declare class UsersApi extends runtime.BaseAPI { /** * Returns details of the users specified by one or more account IDs. **[Permissions](#permissions) required:** Permission to access Jira. * Bulk get users */ bulkGetUsersRaw(requestParameters: BulkGetUsersRequest): Promise>; /** * Returns details of the users specified by one or more account IDs. **[Permissions](#permissions) required:** Permission to access Jira. * Bulk get users */ bulkGetUsers(requestParameters: BulkGetUsersRequest): Promise; /** * Returns the account IDs for the users specified in the `key` or `username` parameters. Note that multiple `key` or `username` parameters can be specified. **[Permissions](#permissions) required:** Permission to access Jira. * Get account IDs for users */ bulkGetUsersMigrationRaw(requestParameters: BulkGetUsersMigrationRequest): Promise>>; /** * Returns the account IDs for the users specified in the `key` or `username` parameters. Note that multiple `key` or `username` parameters can be specified. **[Permissions](#permissions) required:** Permission to access Jira. * Get account IDs for users */ bulkGetUsersMigration(requestParameters: BulkGetUsersMigrationRequest): Promise>; /** * Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated. The option is provided to set or generate a password for the user. When using the option to generate a password, by omitting `password` from the request, include `\"notification\": \"true\"` to ensure the user is sent an email advising them that their account is created. This email includes a link for the user to set their password. If the notification isn\'t sent for a generated password, the user will need to be sent a reset password request from Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create user */ createUserRaw(requestParameters: CreateUserRequest): Promise>; /** * Creates a user. This resource is retained for legacy compatibility. As soon as a more suitable alternative is available this resource will be deprecated. The option is provided to set or generate a password for the user. When using the option to generate a password, by omitting `password` from the request, include `\"notification\": \"true\"` to ensure the user is sent an email advising them that their account is created. This email includes a link for the user to set their password. If the notification isn\'t sent for a generated password, the user will need to be sent a reset password request from Jira. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Create user */ createUser(requestParameters: CreateUserRequest): Promise; /** * Returns a list of all (active and inactive) users. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get all users */ getAllUsersRaw(requestParameters: GetAllUsersRequest): Promise>>; /** * Returns a list of all (active and inactive) users. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get all users */ getAllUsers(requestParameters: GetAllUsersRequest): Promise>; /** * Returns a user. **[Permissions](#permissions) required:** Permission to access Jira. * Get user */ getUserRaw(requestParameters: GetUserRequest): Promise>; /** * Returns a user. **[Permissions](#permissions) required:** Permission to access Jira. * Get user */ getUser(requestParameters: GetUserRequest): Promise; /** * Returns the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an accountId is not passed in the request, the calling user\'s details are returned. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLgl), to get the column details for any user. * Permission to access Jira, to get the calling user\'s column details. * Get user default columns */ getUserDefaultColumnsRaw(requestParameters: GetUserDefaultColumnsRequest): Promise>>; /** * Returns the default [issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an accountId is not passed in the request, the calling user\'s details are returned. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLgl), to get the column details for any user. * Permission to access Jira, to get the calling user\'s column details. * Get user default columns */ getUserDefaultColumns(requestParameters: GetUserDefaultColumnsRequest): Promise>; /** * Returns a user\'s email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). * Get user email */ getUserEmailRaw(requestParameters: GetUserEmailRequest): Promise>; /** * Returns a user\'s email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). * Get user email */ getUserEmail(requestParameters: GetUserEmailRequest): Promise; /** * Returns a user\'s email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). * Get user email bulk */ getUserEmailBulkRaw(requestParameters: GetUserEmailBulkRequest): Promise>; /** * Returns a user\'s email address. This API is only available to apps approved by Atlassian, according to these [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603). * Get user email bulk */ getUserEmailBulk(requestParameters: GetUserEmailBulkRequest): Promise; /** * Returns the groups to which a user belongs. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get user groups */ getUserGroupsRaw(requestParameters: GetUserGroupsRequest): Promise>>; /** * Returns the groups to which a user belongs. **[Permissions](#permissions) required:** *Browse users and groups* [global permission](https://confluence.atlassian.com/x/x4dKLg). * Get user groups */ getUserGroups(requestParameters: GetUserGroupsRequest): Promise>; /** * Deletes a user. **[Permissions](#permissions) required:** Site administration (that is, membership of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). * Delete user */ removeUserRaw(requestParameters: RemoveUserRequest): Promise>; /** * Deletes a user. **[Permissions](#permissions) required:** Site administration (that is, membership of the *site-admin* [group](https://confluence.atlassian.com/x/24xjL)). * Delete user */ removeUser(requestParameters: RemoveUserRequest): Promise; /** * Resets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system default. If an accountId is not passed, the calling user\'s default columns are reset. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user. * Permission to access Jira, to set the calling user\'s columns. * Reset user default columns */ resetUserColumnsRaw(requestParameters: ResetUserColumnsRequest): Promise>; /** * Resets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user to the system default. If an accountId is not passed, the calling user\'s default columns are reset. **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user. * Permission to access Jira, to set the calling user\'s columns. * Reset user default columns */ resetUserColumns(requestParameters: ResetUserColumnsRequest): Promise; /** * Sets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an accountId is not passed, the calling user\'s default columns are set. If no column details are sent, then all default columns are removed. The parameters for this resource are expressed as HTML form data. For example, in curl: `curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5\'` **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user. * Permission to access Jira, to set the calling user\'s columns. * Set user default columns */ setUserColumnsRaw(requestParameters: SetUserColumnsRequest): Promise>; /** * Sets the default [ issue table columns](https://confluence.atlassian.com/x/XYdKLg) for the user. If an accountId is not passed, the calling user\'s default columns are set. If no column details are sent, then all default columns are removed. The parameters for this resource are expressed as HTML form data. For example, in curl: `curl -X PUT -d columns=summary -d columns=description https://your-domain.atlassian.net/rest/api/3/user/columns?accountId=5b10ac8d82e05b22cc7d4ef5\'` **[Permissions](#permissions) required:** * *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg), to set the columns on any user. * Permission to access Jira, to set the calling user\'s columns. * Set user default columns */ setUserColumns(requestParameters: SetUserColumnsRequest): Promise; }