Interface CxIdentityServiceClient

  • All Known Implementing Classes:
    CxIdentityServiceClientAdapter

    public interface CxIdentityServiceClient
    Client reading information from yaas identity service.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.util.List<ProfileReference> getProfileReferences​(java.lang.String identityKey, java.lang.String identityType, java.lang.String identityOrigin)
      Finds profile references based on identity (e.g.
      java.util.List<ProfileReference> getProfileReferences​(java.lang.String identityKey, java.lang.String identityType, java.lang.String identityOrigin, int limit, java.lang.String sortBy, java.lang.String sortDirection)
      Finds profile references based on identity (e.g.
      rx.Observable<java.util.List<ProfileReference>> getProfileReferencesAsync​(java.lang.String identityKey, java.lang.String identityType, java.lang.String identityOrigin)
      Finds profile references based on identity (e.g.
      rx.Observable<java.util.List<ProfileReference>> getProfileReferencesAsync​(java.lang.String identityKey, java.lang.String identityType, java.lang.String identityOrigin, int limit, java.lang.String sortBy, java.lang.String sortDirection)
      Finds profile references based on identity (e.g.
    • Method Detail

      • getProfileReferences

        @GET
        @Path("/${tenant}/profileReferences?identityKey={key}&identityType={type}&identityOrigin={origin}")
        java.util.List<ProfileReference> getProfileReferences​(@PathParam("key")
                                                              java.lang.String identityKey,
                                                              @PathParam("type")
                                                              java.lang.String identityType,
                                                              @PathParam("origin")
                                                              java.lang.String identityOrigin)
        Finds profile references based on identity (e.g. user email, session identifier)
        Parameters:
        identityKey - Identity key
        identityType - Identity type
        identityOrigin - Identity origin
        Returns:
        Profile references
      • getProfileReferences

        @GET
        @Path("/${tenant}/profileReferences?identityKey={key}&identityType={type}&identityOrigin={origin}&limit={limit}&sortBy={sortBy}&sortDirection={sortDirection}")
        java.util.List<ProfileReference> getProfileReferences​(@PathParam("key")
                                                              java.lang.String identityKey,
                                                              @PathParam("type")
                                                              java.lang.String identityType,
                                                              @PathParam("origin")
                                                              java.lang.String identityOrigin,
                                                              @PathParam("limit")
                                                              int limit,
                                                              @PathParam("sortBy")
                                                              java.lang.String sortBy,
                                                              @PathParam("sortDirection")
                                                              java.lang.String sortDirection)
        Finds profile references based on identity (e.g. user email, session identifier)
        Parameters:
        identityKey - Identity key
        identityType - Identity type
        identityOrigin - Identity origin
        limit - Limit of profile references to return
        sortBy - Attribute on which profile references will be sorted
        sortDirection - Sorting direction
        Returns:
        Profile references
      • getProfileReferencesAsync

        @GET
        @Path("/${tenant}/profileReferences?identityKey={key}&identityType={type}&identityOrigin={origin}")
        rx.Observable<java.util.List<ProfileReference>> getProfileReferencesAsync​(@PathParam("key")
                                                                                  java.lang.String identityKey,
                                                                                  @PathParam("type")
                                                                                  java.lang.String identityType,
                                                                                  @PathParam("origin")
                                                                                  java.lang.String identityOrigin)
        Finds profile references based on identity (e.g. user email, session identifier). Method runs asynchronously.
        Parameters:
        identityKey - Identity key
        identityType - Identity type
        identityOrigin - Identity origin
        Returns:
        Profile references
      • getProfileReferencesAsync

        @GET
        @Path("/${tenant}/profileReferences?identityKey={key}&identityType={type}&identityOrigin={origin}&limit={limit}&sortBy={sortBy}&sortDirection={sortDirection}")
        rx.Observable<java.util.List<ProfileReference>> getProfileReferencesAsync​(@PathParam("key")
                                                                                  java.lang.String identityKey,
                                                                                  @PathParam("type")
                                                                                  java.lang.String identityType,
                                                                                  @PathParam("origin")
                                                                                  java.lang.String identityOrigin,
                                                                                  @PathParam("limit")
                                                                                  int limit,
                                                                                  @PathParam("sortBy")
                                                                                  java.lang.String sortBy,
                                                                                  @PathParam("sortDirection")
                                                                                  java.lang.String sortDirection)
        Finds profile references based on identity (e.g. user email, session identifier). Method runs asynchronously.
        Parameters:
        identityKey - Identity key
        identityType - Identity type
        identityOrigin - Identity origin
        limit - Limit of profile references to return
        sortBy - Attribute on which profile references will be sorted
        sortDirection - Sorting direction
        Returns:
        Profile references