Authentication (Sessions)

Get session

get

Gets current session (checks if user is logged in).

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringOptional

Query parameters

includestring[]Optional

Specify additional objects to include in the session response. Supports 'csrfToken' and 'user'. Multiple inclusions may be specified using additional 'include' query parameters or by comma-separated list.

Responses

200

The user is logged in.

application/json

csrfTokenstringOptional

401

The user is not authenticated.

get/auth/sessions/current

HTTPcURLJavaScriptPython

GET /rest/2.0/auth/sessions/current HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "csrfToken": "text",
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "userName": "text",
    "firstName": "text",
    "lastName": "text",
    "title": "text",
    "department": "text",
    "emailAddress": "text",
    "gender": "MALE",
    "language": "text",
    "additionalEmailAddresses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "emailAddress": "text"
      }
    ],
    "phoneNumbers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "type": "FAX",
        "phoneNumber": "text"
      }
    ],
    "instantMessagingAccounts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "account": "text",
        "type": "AOL"
      }
    ],
    "websites": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "url": "text",
        "type": "FACEBOOK"
      }
    ],
    "addresses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "city": "text",
        "street": "text",
        "number": "text",
        "state": "text",
        "country": "text",
        "postalCode": "text",
        "type": "HOME"
      }
    ],
    "activated": true,
    "enabled": true,
    "ldapUser": true,
    "userSource": "INTERNAL",
    "guestUser": true
  }
}

Logout

delete

Logs current user out and destroys the active session.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringOptional

Responses

204

The user was logged out and session closed.

No content

401

The user is not authenticated.

delete/auth/sessions/current

HTTPcURLJavaScriptPython

DELETE /rest/2.0/auth/sessions/current HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Checks if the user session is active

get

Returns 200 if user session is active and 401 if the session is expired or doesn't exist

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringOptional

Responses

200

The user is authenticated

No content

401

The user is not authenticated.

get/auth/sessions/heartbeat

HTTPcURLJavaScriptPython

GET /rest/2.0/auth/sessions/heartbeat HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Login

post

Authenticates a user and creates a new session on the server. Once the user is authenticated then the returned session id can be used to access DGC REST Api in subsequent requests. The method additionally returns the JSESSIONID cookie in a Set-Cookie header. If user already has an open session then this session will be terminated.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringOptional

Body

application/json

usernamestringOptional

passwordstringOptional

Responses

200

The user was logged in and a new session was created. The response includes the CSRF token that is created

application/json

csrfTokenstringOptional

401

The user is not authenticated.

post/auth/sessions

HTTPcURLJavaScriptPython

POST /rest/2.0/auth/sessions HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "username": "text",
  "password": "text"
}

{
  "csrfToken": "text",
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "userName": "text",
    "firstName": "text",
    "lastName": "text",
    "title": "text",
    "department": "text",
    "emailAddress": "text",
    "gender": "MALE",
    "language": "text",
    "additionalEmailAddresses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "emailAddress": "text"
      }
    ],
    "phoneNumbers": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "type": "FAX",
        "phoneNumber": "text"
      }
    ],
    "instantMessagingAccounts": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "account": "text",
        "type": "AOL"
      }
    ],
    "websites": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "url": "text",
        "type": "FACEBOOK"
      }
    ],
    "addresses": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "city": "text",
        "street": "text",
        "number": "text",
        "state": "text",
        "country": "text",
        "postalCode": "text",
        "type": "HOME"
      }
    ],
    "activated": true,
    "enabled": true,
    "ldapUser": true,
    "userSource": "INTERNAL",
    "guestUser": true
  }
}