• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLink
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • search
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / Reference / REST API

session

Postman Collection
OpenAPI
Operations
GET/auth/1/sessionPOST/auth/1/sessionDEL/auth/1/session
GET

Get current user session information

Returns information about the currently authenticated user's session. If the caller is not authenticated they will get a 401 Unauthorized status code.

Request

This request has no parameters.

Responses

Returned if the currently authenticated user is returned.

application/json

CurrentUser

GET/auth/1/session
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/auth/1/session' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
POST

Create new user session

Creates a new session for a user in Jira. Once a session has been successfully created it can be used to access any of Jira's remote APIs and also the web UI by passing the appropriate HTTP Cookie header. Note that it is generally preferrable to use HTTP BASIC authentication with the REST API. However, this resource may be used to mimic the behaviour of Jira's log-in page (e.g. to display log-in errors to a user).

Request

Request bodyapplication/json

the username and password to authenticate

password

string

username

string

Responses

Returned if the caller is authenticated. Contains information about the caller's session.

application/json

AuthSuccess
POST/auth/1/session
1 2 3 4 5 curl --request POST \ --url 'http://{baseurl}/rest/auth/1/session' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json'
DEL

Delete current user session

Logs the current user out of Jira, destroying the existing session, if any.

Request

This request has no parameters.

Responses

Returned if the user was successfully logged out.

DEL/auth/1/session
1 2 3 curl --request DELETE \ --url 'http://{baseurl}/rest/auth/1/session' \ --user 'email@example.com:<api_token>'

Rate this page: