Package com.intercom.api.resources.unstable.admins

Class AdminsClient

java.lang.Object

com.intercom.api.resources.unstable.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
java.util.Optional<AdminWithApp>	identifyAdmin()	You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
java.util.Optional<AdminWithApp>	identifyAdmin(RequestOptions requestOptions)	You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).
ActivityLogList	listActivityLogs(ListActivityLogsRequest request)	You can get a log of activities by all admins in an app.
ActivityLogList	listActivityLogs(ListActivityLogsRequest request, RequestOptions requestOptions)	You can get a log of activities by all admins in an app.
AdminList	listAdmins()	You can fetch a list of admins for a given workspace.
AdminList	listAdmins(RequestOptions requestOptions)	You can fetch a list of admins for a given workspace.
java.util.Optional<Admin>	retrieveAdmin(RetrieveAdminRequest request)	You can retrieve the details of a single admin.
java.util.Optional<Admin>	retrieveAdmin(RetrieveAdminRequest request, RequestOptions requestOptions)	You can retrieve the details of a single admin.
java.util.Optional<Admin>	setAwayAdmin(SetAwayAdminRequest request)	You can set an Admin as away for the Inbox.
java.util.Optional<Admin>	setAwayAdmin(SetAwayAdminRequest request, RequestOptions requestOptions)	You can set an Admin as away for the Inbox.
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

identifyAdmin

public java.util.Optional<AdminWithApp> identifyAdmin()

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.

identifyAdmin

public java.util.Optional<AdminWithApp> identifyAdmin(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.

setAwayAdmin

public java.util.Optional<Admin> setAwayAdmin(SetAwayAdminRequest request)

You can set an Admin as away for the Inbox.

setAwayAdmin

public java.util.Optional<Admin> setAwayAdmin(SetAwayAdminRequest request,
                                              RequestOptions requestOptions)

You can set an Admin as away for the Inbox.

listActivityLogs

public ActivityLogList listActivityLogs(ListActivityLogsRequest request)

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

listActivityLogs

public ActivityLogList listActivityLogs(ListActivityLogsRequest request,
                                        RequestOptions requestOptions)

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

listAdmins

public AdminList listAdmins()

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

listAdmins

public AdminList listAdmins(RequestOptions requestOptions)

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

retrieveAdmin

public java.util.Optional<Admin> retrieveAdmin(RetrieveAdminRequest request)

You can retrieve the details of a single admin.

retrieveAdmin

public java.util.Optional<Admin> retrieveAdmin(RetrieveAdminRequest request,
                                               RequestOptions requestOptions)

You can retrieve the details of a single admin.