org.exoplatform.social.service.rest.api

Class IdentityResources

java.lang.Object

org.exoplatform.social.service.rest.api.IdentityResources

All Implemented Interfaces:

org.exoplatform.services.rest.resource.ResourceContainer

public class IdentityResources
extends Object
implements org.exoplatform.services.rest.resource.ResourceContainer

Provides API to access the identity resources.

Since:

1.2.2

eXo anchor for generated doc on REST API

IdentityResources

Constructor Summary

Constructors

Constructor and Description
IdentityResources()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getIdentityById(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String identityId, String format) Deprecated. Deprecated from 4.3.x. Replaced by a new API IdentityRestResourcesV1#getIdentityById(org.exoplatform.social.rest.impl.identity.UriInfo, String, String)
javax.ws.rs.core.Response	getIdentityProviderIdAndRemoteId(javax.ws.rs.core.UriInfo uriInfo, String portalContainerName, String providerId, String remoteId, String format) Gets the identity and its associated profile by specifying its provider Id and user/space Id.

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityResources

public IdentityResources()

Method Detail

getIdentityById

public javax.ws.rs.core.Response getIdentityById(@Context
                                                 javax.ws.rs.core.UriInfo uriInfo,
                                                 String portalContainerName,
                                                 String identityId,
                                                 String format)

Deprecated. Deprecated from 4.3.x. Replaced by a new API IdentityRestResourcesV1#getIdentityById(org.exoplatform.social.rest.impl.identity.UriInfo, String, String)

Gets the identity and its associated profile by the activity Id.

Parameters:

uriInfo - The requested URI information.

portalContainerName - The associated portal container name.

identityId - The Id of the specified identity.

format - The format of the returned result, for example, JSON or XML.

Returns:

a response object

eXo level API

Platform

eXo anchor for generated doc on REST API

IdentityResources.getIdentityById

eXo anchor for generated doc on REST API

GET http://localhost:8080/rest/private/api/social/v1-alpha3/portal/identity/123456789.json

eXo response for generated doc on REST API

{ "id" : "123456789", "providerId": "organization", "remoteId": "demo", "profile": { "fullName": "Demo Gtn", "avatarUrl": "http://localhost:8080/profile/avatar/demo.jpg" } }

eXo authentication for generated doc on REST API

getIdentityProviderIdAndRemoteId

public javax.ws.rs.core.Response getIdentityProviderIdAndRemoteId(@Context
                                                                  javax.ws.rs.core.UriInfo uriInfo,
                                                                  String portalContainerName,
                                                                  String providerId,
                                                                  String remoteId,
                                                                  String format)

Gets the identity and its associated profile by specifying its provider Id and user/space Id. There can be many identities, such as, user identities, and space identities.

Parameters:

uriInfo - The requested URI information.

portalContainerName - The associated portal container name.

providerId - The provider Id of the identity.

remoteId - The user/space Id.

format - The format of the returned result, for example, JSON or XML.

Returns:

a response object

Since:

1.2.2 *user identities*: _providerId_ = organization; _remoteId_ = portal user name. *space identities:* _providerId_ = space; _remoteId_ = space's pretty name.

eXo level API

Platform

eXo anchor for generated doc on REST API

IdentityResources.getIdentityProviderIdAndRemoteId

eXo anchor for generated doc on REST API

GET http://localhost:8080/rest/private/api/social/v1-alpha3/portal/identity/organization/demo.json

eXo response for generated doc on REST API

{ "id" : "123456789", "providerId": "organization", "remoteId": "demo", "profile": { "fullName": "Demo Gtn", "avatarUrl": "http://localhost:8080/portal/demo/profile/avatar/demo.jpg" } }

eXo authentication for generated doc on REST API