Package com.intercom.api.resources.admins

Class AdminsClient

java.lang.Object

com.intercom.api.resources.admins.AdminsClient

public class AdminsClient
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field	Description
protected ClientOptions	clientOptions

Constructor Summary

Constructors

Constructor	Description
AdminsClient(ClientOptions clientOptions)

Method Summary

Modifier and Type	Method	Description
Admin	away(ConfigureAwayAdminRequest request)	You can set an Admin as away for the Inbox.
Admin	away(ConfigureAwayAdminRequest request, RequestOptions requestOptions)	You can set an Admin as away for the Inbox.
Admin	find(FindAdminRequest request)	You can retrieve the details of a single admin.
Admin	find(FindAdminRequest request, RequestOptions requestOptions)	You can retrieve the details of a single admin.
AdminWithApp	identify()	You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
AdminWithApp	identify(RequestOptions requestOptions)	You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
AdminList	list()	You can fetch a list of admins for a given workspace.
AdminList	list(RequestOptions requestOptions)	You can fetch a list of admins for a given workspace.
ActivityLogList	listAllActivityLogs(ListAllActivityLogsRequest request)	You can get a log of activities by all admins in an app.
ActivityLogList	listAllActivityLogs(ListAllActivityLogsRequest request, RequestOptions requestOptions)	You can get a log of activities by all admins in an app.
RawAdminsClient	withRawResponse()	Get responses with HTTP metadata like headers

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

clientOptions

protected final ClientOptions clientOptions

Constructor Detail

AdminsClient

public AdminsClient(ClientOptions clientOptions)

Method Detail

withRawResponse

public RawAdminsClient withRawResponse()

Get responses with HTTP metadata like headers

identify

public AdminWithApp identify()

You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).

🚧 Single Sign On

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

identify

public AdminWithApp identify(RequestOptions requestOptions)

You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).

🚧 Single Sign On

If you are building a custom "Log in with Intercom" flow for your site, and you call the /me endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.

away

public Admin away(ConfigureAwayAdminRequest request)

You can set an Admin as away for the Inbox.

away

public Admin away(ConfigureAwayAdminRequest request,
                  RequestOptions requestOptions)

You can set an Admin as away for the Inbox.

listAllActivityLogs

public ActivityLogList listAllActivityLogs(ListAllActivityLogsRequest request)

You can get a log of activities by all admins in an app.

listAllActivityLogs

public ActivityLogList listAllActivityLogs(ListAllActivityLogsRequest request,
                                           RequestOptions requestOptions)

You can get a log of activities by all admins in an app.

list

public AdminList list()

You can fetch a list of admins for a given workspace.

list

public AdminList list(RequestOptions requestOptions)

You can fetch a list of admins for a given workspace.

find

public Admin find(FindAdminRequest request)

You can retrieve the details of a single admin.

find

public Admin find(FindAdminRequest request,
                  RequestOptions requestOptions)

You can retrieve the details of a single admin.