Package com.cumulocity.sdk.client.identity

Interface IdentityApi

All Known Implementing Classes:

IdentityApiImpl

public interface IdentityApi

API for creating, deleting and retrieving external ids from the platform.

Method Summary

Modifier and Type	Method	Description
ExternalIDRepresentation	create(ExternalIDRepresentation externalId)	Creates an association between the external id and its global id in the platform.
void	deleteExternalId(ExternalIDRepresentation externalId)	Deletes between the external id and its global id in the platform.
ExternalIDRepresentation	getExternalId(ID extId)	Gets external id representation from the platform by the given external id.
ExternalIDCollection	getExternalIdsOfGlobalId(GId gid)	Gets the external ids associated with the given global id

Method Detail

create

ExternalIDRepresentation create(ExternalIDRepresentation externalId)
                         throws SDKException

Creates an association between the external id and its global id in the platform.

Parameters:

externalId - the external to be created

Returns:

the created external id

Throws:

SDKException - if the external id could not be created

getExternalId

ExternalIDRepresentation getExternalId(ID extId)
                                throws SDKException

Gets external id representation from the platform by the given external id. The returned external id contains the managed object. The global id associated with the given external id can be extracted from that managed object

Parameters:

extId - id of the event to search for

Returns:

the external id representation including the managed object

Throws:

SDKException - if the external id is not found or if the query failed

getExternalIdsOfGlobalId

ExternalIDCollection getExternalIdsOfGlobalId(GId gid)
                                       throws SDKException

Gets the external ids associated with the given global id

Parameters:

gid - the global of the external ids to search for

Returns:

a collection of external ids with paging functionality

Throws:

SDKException - if the query failed

deleteExternalId

void deleteExternalId(ExternalIDRepresentation externalId)
               throws SDKException

Deletes between the external id and its global id in the platform.

Parameters:

externalId - the external id to be deleted

Throws:

SDKException - if the external could not be deleted