Sessions

When an administrator, agent, or end user signs in to a Zendesk Support instance, asessionis created. The Sessions API lets you view who is currently signed in. It also lets you terminate one or more sessions. Terminating a session signs out the user.

JSON format

Sessions are represented as JSON objects with the following properties:

Name	Type	Read-only	Mandatory	Description
authenticated_at	string	false	false	When the session was created
id	integer	false	true	Automatically assigned when the session is created
last_seen_at	string	false	false	The last approximate time this session was seen. This does not update on every request.
url	string	false	false	The API URL of this session
user_id	integer	false	false	The id of the user

Example

             
              {"authenticated_at":"2014-11-18T17:24:29Z","id":3432,"last_seen_at":"2014-11-18T17:30:52Z","url":"https://company.zendesk.com/api/v2/users/12345/sessions/3432.json","user_id":12345}

List Sessions

GET /api/v2/sessions
GET /api/v2/users/{user_id}/sessions.json

如果认证作为一个管理员,返回所有的亚柯unt's sessions. If authenticated as an agent or end user, returns only the sessions of the user making the request.

Pagination

Cursor pagination (recommended)
Offset pagination

SeePagination.

Allowed For

Admins, Agents, End users

Parameters

Name	Type	In	Required	Description
user_id	integer	Path	true	The id of the user

代码示例

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/sessions.json\-v -u{email_address}:{password}

              
               import("fmt""io""net/http")funcmain(){url:="https://example.zendesk.com/api/v2/sessions"method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/sessions").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'GET',url:'https://example.zendesk.com/api/v2/sessions',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://example.zendesk.com/api/v2/sessions"headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://example.zendesk.com/api/v2/sessions")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

200 OK

              
               // Status 200 OK{"sessions":[{"authenticated_at":"2014-11-18T17:24:29Z","id":3432,"last_seen_at":"2014-11-18T17:30:52Z","url":"https://company.zendesk.com/api/v2/users/12345/sessions/3432.json","user_id":12345}]}

Show Session

GET /api/v2/users/{user_id}/sessions/{session_id}

Allowed For

Admins, Agents, End users

Parameters

Name	Type	In	Required	Description
session_id	integer	Path	true	The ID of the session
user_id	integer	Path	true	The id of the user

代码示例

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/users/{user_id}/sessions/{session_id}.json\-v -u{email_address}:{password}

              
               import("fmt""io""net/http")funcmain(){url:="https://example.zendesk.com/api/v2/users/35436/sessions/14"method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/users/35436/sessions/14").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'GET',url:'https://example.zendesk.com/api/v2/users/35436/sessions/14',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://example.zendesk.com/api/v2/users/35436/sessions/14"headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://example.zendesk.com/api/v2/users/35436/sessions/14")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

200 OK

              
               // Status 200 OK{"session":[{"authenticated_at":"2014-11-18T17:24:29Z","id":3432,"last_seen_at":"2014-11-18T17:30:52Z","url":"https://company.zendesk.com/api/v2/users/12345/sessions/3432.json","user_id":12345}]}

Show the Currently Authenticated Session

GET /api/v2/users/me/session

Allowed For

Admins, Agents, End users

代码示例

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/users/me/session.json\-v -u{email_address}:{password}

              
               import("fmt""io""net/http")funcmain(){url:="https://example.zendesk.com/api/v2/users/me/session"method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/users/me/session").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'GET',url:'https://example.zendesk.com/api/v2/users/me/session',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://example.zendesk.com/api/v2/users/me/session"headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://example.zendesk.com/api/v2/users/me/session")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

200 OK

              
               // Status 200 OK{"session":[{"authenticated_at":"2014-11-18T17:24:29Z","id":3432,"last_seen_at":"2014-11-18T17:30:52Z","url":"https://company.zendesk.com/api/v2/users/12345/sessions/3432.json","user_id":12345}]}

Renew the current session

GET /api/v2/users/me/session/renew

Allowed For

Admins, Agents, End users

代码示例

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/users/me/session/renew.json\-v -u{email_address}:{password}

              
               import("fmt""io""net/http")funcmain(){url:="https://example.zendesk.com/api/v2/users/me/session/renew"method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/users/me/session/renew").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'GET',url:'https://example.zendesk.com/api/v2/users/me/session/renew',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://example.zendesk.com/api/v2/users/me/session/renew"headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://example.zendesk.com/api/v2/users/me/session/renew")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

200 OK

              
               // Status 200 OK{"authenticity_token":"huU19Z76zNC9Yvt+i9p7MviIOlOIg/JWqEdf6nGmnu9JInV04fksCIdtNDvoYAoV"}

删除Session

DELETE /api/v2/users/{user_id}/sessions/{session_id}

Allowed For

Admins, Agents, End users

Parameters

Name	Type	In	Required	Description
session_id	integer	Path	true	The ID of the session
user_id	integer	Path	true	The id of the user

代码示例

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/users/{user_id}/sessions/{session_id}.json\-v -u{email_address}:{password}-X DELETE

              
               import("fmt""io""net/http")funcmain(){url:="https://example.zendesk.com/api/v2/users/35436/sessions/14"method:="DELETE"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/users/35436/sessions/14").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("DELETE",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'DELETE',url:'https://example.zendesk.com/api/v2/users/35436/sessions/14',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://example.zendesk.com/api/v2/users/35436/sessions/14"headers={"Content-Type":"application/json",}response=requests.request("DELETE",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://example.zendesk.com/api/v2/users/35436/sessions/14")request=Net::HTTP::删除.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

204 No Content

              
               // Status 204 No Contentnull

删除the Authenticated Session

GET /api/v2/users/me/logout

删除s the current session. In practice, this only works when using session auth for requests, such as client-side requests made from a Zendesk app. When using OAuth or basic authentication, you don't have a current session so this endpoint has no effect.

Allowed For

Admins, Agents, End users

代码示例

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/users/me/logout.json\-v -u{email_address}:{password}-X DELETE

              
               import("fmt""io""net/http")funcmain(){url:="https://example.zendesk.com/api/v2/users/me/logout"method:="GET"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/users/me/logout").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("GET",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'GET',url:'https://example.zendesk.com/api/v2/users/me/logout',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://example.zendesk.com/api/v2/users/me/logout"headers={"Content-Type":"application/json",}response=requests.request("GET",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://example.zendesk.com/api/v2/users/me/logout")request=Net::HTTP::Get.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

204 No Content

              
               // Status 204 No Contentnull

Bulk Delete Sessions

DELETE /api/v2/users/{user_id}/sessions

删除s all the sessions for a user.

Allowed For

Admins, Agents, End users

Parameters

Name	Type	In	Required	Description
user_id	integer	Path	true	The id of the user

代码示例

旋度

              
               旋度https://{subdomain}.zendesk.com/api/v2/users/{user_id}/sessions.json\-v -u{email_address}:{password}-X DELETE

              
               import("fmt""io""net/http")funcmain(){url:="https://example.zendesk.com/api/v2/users/35436/sessions"method:="DELETE"req,err:=http.NewRequest(method,url,nil)iferr!=nil{fmt.Println(err)return}req.Header.Add("Content-Type","application/json")req.Header.Add("Authorization","Basic ")// Base64 encoded "username:password"client:=&http.Client{}res,err:=client.Do(req)iferr!=nil{fmt.Println(err)return}deferres.Body.Close()body,err:=io.ReadAll(res.Body)iferr!=nil{fmt.Println(err)return}fmt.Println(string(body))}

Java

              
               importcom.squareup.okhttp.*;OkHttpClientclient=newOkHttpClient();HttpUrl.BuilderurlBuilder=HttpUrl.parse("https://example.zendesk.com/api/v2/users/35436/sessions").newBuilder();Requestrequest=newRequest.Builder().url(urlBuilder.build()).method("DELETE",null).addHeader("Content-Type","application/json").addHeader("Authorization",Credentials.basic("your-email","your-password")).build();Responseresponse=client.newCall(request).execute();

Nodejs

              
               varaxios=require('axios');varconfig={method:'DELETE',url:'https://example.zendesk.com/api/v2/users/35436/sessions',headers:{'Content-Type':'application/json','Authorization':'Basic ',// Base64 encoded "username:password"},};axios(config).then(function(response){console.log(JSON.stringify(response.data));}).catch(function(error){console.log(error);});

Python

              
               importrequestsurl="https://example.zendesk.com/api/v2/users/35436/sessions"headers={"Content-Type":"application/json",}response=requests.request("DELETE",url,auth=('',''),headers=headers)print(response.text)

Ruby

              
               require"net/http"uri=URI("https://example.zendesk.com/api/v2/users/35436/sessions")request=Net::HTTP::删除.new(uri,"Content-Type":"application/json")request.basic_auth"username","password"response=Net::HTTP.start uri.hostname,uri.port,use_ssl:truedo|http|http.request(request)end

Example response(s)

204 No Content

              
               // Status 204 No Contentnull