Skip to content

jira get-users

Returns a list of all users (active, inactive and deleted users) .

Description

Returns a list of all users (active, inactive and deleted users) .

Synopsis

jira get-users
    --site <site>
    [<user>]
    [--expand <expand>]
    [--start_index <start_index>]
    [--max <max>]

Arguments

site - (string)

    
     Example: --site "site-1"
     Default: localhost:8081      Attributes: required

user - (string)

     The account ID of the user
     Example: "user-1"
     Default: _None_      Attributes: optional

     Validation:
         max length: 128

expand - (string)

     Use expand to include additional information about users in the response.
     Example: --expand "expand-1"
     Default: _None_      Attributes: optional

     Validation:
         allowed values: groups, applicationRoles

start_index - (int)

     The index of the first item to return.
     Example: --start_index 1
     Default: 0      Attributes: optional

max - (int)

     The maximum number of items to return per page.
     Example: --max 1
     Default: 50      Attributes: optional

Examples

Input: 

!jira get-users
Output: 
ID                                          NAME                            ACCOUNTTYPE ACTIVE 
63847d7b77acd224b33fd715                    Avinash Bharti - EXT            atlassian   true    
557058:f58131cb-b67d-43c7-b30d-6b58d40bd077 Automation for Jira             app         true    
5d53f3cbc6b9320d9ea5bdc2                    Jira Outlook                    app         true    
5cb4ae0e4b97ab11a18e00c7                    Atlassian Assist                app         true    
60e5a86a471e61006a4c51fd                    Microsoft Teams for Jira Cloud  app         true    
557058:0867a421-a9ee-4659-801a-bc0ee4a4487e Slack                           app         true    
557058:950f9f5b-3d6d-4e1d-954a-21367ae9ac75 Jira Service Management Widget  app         true    
5dd64082af96bc0efbe55103                    Opsgenie Integration            app         true    
557058:214cdd6a-ff93-4d8b-838b-62dfcf1a2a71 Trello                          app         true    
5b6c7b3afbc68529c6c47967                    Statuspage for Jira             app         true    
5cf112d31552030f1e3a5905                    Jira Spreadsheets               app         true
Input: 
!jira get-users --user "63847d7b77acd224b33fd715"
Output: 
ID                                          NAME                            ACCOUNTTYPE ACTIVE 
63847d7b77acd224b33fd715                    Avinash Bharti - EXT            atlassian   true

Access Control

To use this command, you need access to the following:

Field Value
Action "read"
Service Type "jira"
Service Instance
Namespace
Object Type "user"
Object ID user

Please see Access Control for details.