@convergence/convergence

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>IdentityService | Convergence JavaScript Client API Documentation</title> <meta name="description" content="Documentation for Convergence JavaScript Client API Documentation"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="../assets/css/main.css"> <link rel="icon" type="image/png" href="https://convergence.io/assets/img/favicon/favicon-16x16.png" sizes="16x16"> <link rel="icon" type="image/png" href="https://convergence.io/assets/img/favicon/favicon-32x32.png" sizes="32x32"> <link rel="icon" type="image/ico" href="https://convergence.io/assets/img/favicon/favicon.ico" sizes="48x48"> <link rel="icon" type="image/png" href="https://convergence.io/assets/img/favicon/favicon-96x96.png" sizes="96x96">  <script id="ze-snippet" src="https://static.zdassets.com/ekr/snippet.js?key=3ee5157d-2fc2-4b08-b6c7-d5fad0533179"> </script>  </head> <body> <header> <div class="tsd-page-toolbar convergence-header"> <div class="container"> <div class="flex-content"> <a href="../index.html" class="header-brand"> <img src=../assets/images/convergence-logo.png /> <span class="brand-title brand-copy">Convergence JavaScript Client API Documentation</span> <span class="version">1.0.0-rc.12</span> </a> <div class="links brand-copy"> <div class="link"> <a href="https://docs.convergence.io/guide/">Dev Guide</a> </div> <div class="link"> <a href="https://examples.convergence.io">Examples</a> </div> <div class="link"> <a href="https://convergence.io/support/">Support</a> </div> </div> </div> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base=".."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <ul class="tsd-breadcrumb"> <li> <a href="../globals.html">Index</a> </li> <li> <a href="../modules/users_and_identity.html">Users and Identity</a> </li> <li> <a href="users_and_identity.identityservice.html">IdentityService</a> </li> </ul> <h1>Class IdentityService</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel tsd-comment"> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Provides a suite of utilities for looking up users and groups in the current domain.</p> </div> <p>See some common use cases in the <a href="https://docs.convergence.io/guide/identity/overview.html">developer guide</a>.</p> <p>Note that users and groups cannot (yet) be managed through this service. See the REST API for domain user and group management.</p> <p>This service can be accessed using <a href="convergencedomain.html#identity">ConvergenceDomain.identity</a>.</p> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">IdentityService</span> </li> </ul> </section> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.identityservice.html#group" class="tsd-kind-icon">group</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.identityservice.html#groups" class="tsd-kind-icon">groups</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.identityservice.html#groupsforuser" class="tsd-kind-icon">groups<wbr>For<wbr>User</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.identityservice.html#groupsforusers" class="tsd-kind-icon">groups<wbr>For<wbr>Users</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.identityservice.html#profile" class="tsd-kind-icon">profile</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.identityservice.html#search" class="tsd-kind-icon">search</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.identityservice.html#session" class="tsd-kind-icon">session</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.identityservice.html#user" class="tsd-kind-icon">user</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.identityservice.html#userexists" class="tsd-kind-icon">user<wbr>Exists</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="users_and_identity.identityservice.html#users" class="tsd-kind-icon">users</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Methods</h2> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="group" class="tsd-anchor"></a> <h3>group</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">group<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.usergroup.html" class="tsd-signature-type">UserGroup</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Looks up a single user group by ID. Rejects the promise if no group by the provided ID exists.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>id: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>the user group's ID</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.usergroup.html" class="tsd-signature-type">UserGroup</a><span class="tsd-signature-symbol">></span></h4> <p>a promise to be resolved if the group exists, otherwise a rejection</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="groups" class="tsd-anchor"></a> <h3>groups</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">groups<span class="tsd-signature-symbol">(</span>ids<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.usergroup.html" class="tsd-signature-type">UserGroup</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Looks up one or more User Groups by their User Group Ids. Each returned User Group will contain the details of the User Group, including an array of users ids for those users that are members of the group.</p> </div> <p>Note: that if any of the provided User Group Ids does not exist, the promise will be rejected.</p> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>ids: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p> An array of UserGroup Id's for the groups to get.</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.usergroup.html" class="tsd-signature-type">UserGroup</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> <p> A promise resolved with an array of <a href="users_and_identity.usergroup.html">UserGroup</a>s that positionally correspond to the supplied User Group Id's.</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="groupsforuser" class="tsd-anchor"></a> <h3>groups<wbr>For<wbr>User</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">groups<wbr>For<wbr>User<span class="tsd-signature-symbol">(</span>username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Looks up the groups to which the provided user belongs.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>username: <span class="tsd-signature-type">string</span></h5> <div class="tsd-comment tsd-typography"> <p>an existing user's username</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> <p>a promise to be resolved with an array of group IDs to which the given user belongs</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="groupsforusers" class="tsd-anchor"></a> <h3>groups<wbr>For<wbr>Users</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">groups<wbr>For<wbr>Users<span class="tsd-signature-symbol">(</span>usernames<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Looks up the groups to which the provided users belong.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>usernames: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>an array of usernames</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{}</span><span class="tsd-signature-symbol">></span></h4> <p>a promise to be resolved with an array of group IDs to which the given user belongs</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="profile" class="tsd-anchor"></a> <h3>profile</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">profile<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.domainuser.html" class="tsd-signature-type">DomainUser</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Returns a promise that resolves with some information about the current user.</p> </div> </div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.domainuser.html" class="tsd-signature-type">DomainUser</a><span class="tsd-signature-symbol">></span></h4> <p>a promise to be resolved with the current user's information</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="search" class="tsd-anchor"></a> <h3>search</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">search<span class="tsd-signature-symbol">(</span>query<span class="tsd-signature-symbol">: </span><a href="../interfaces/users_and_identity.userquery.html" class="tsd-signature-type">UserQuery</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.domainuser.html" class="tsd-signature-type">DomainUser</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Searches for <a href="users_and_identity.domainuser.html">DomainUser</a>s based on the provided query configuration.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>query: <a href="../interfaces/users_and_identity.userquery.html" class="tsd-signature-type">UserQuery</a></h5> <div class="tsd-comment tsd-typography"> <p>a query configuration including the actual query and fields to search on</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.domainuser.html" class="tsd-signature-type">DomainUser</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> <p>A promise to be resolved with an array of users, or an empty array if there are no matches</p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="session" class="tsd-anchor"></a> <h3>session</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">session<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="users_and_identity.convergencesession.html" class="tsd-signature-type">ConvergenceSession</a></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>The current session.</p> </div> </div> <h4 class="tsd-returns-title">Returns <a href="users_and_identity.convergencesession.html" class="tsd-signature-type">ConvergenceSession</a></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="user" class="tsd-anchor"></a> <h3>user</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">(</span>userId<span class="tsd-signature-symbol">: </span><a href="../modules/users_and_identity.html#domainuseridentifier" class="tsd-signature-type">DomainUserIdentifier</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.domainuser.html" class="tsd-signature-type">DomainUser</a><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Looks up a user by either a username or <a href="users_and_identity.domainuserid.html">DomainUserId</a>.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>userId: <a href="../modules/users_and_identity.html#domainuseridentifier" class="tsd-signature-type">DomainUserIdentifier</a></h5> <div class="tsd-comment tsd-typography"> <p>either a username string or <a href="users_and_identity.domainuserid.html">DomainUserId</a></p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.domainuser.html" class="tsd-signature-type">DomainUser</a><span class="tsd-signature-symbol">></span></h4> <p>a promise which will be resolved with a <a href="users_and_identity.domainuser.html">DomainUser</a> if one is found, otherwise <code>undefined</code></p> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="userexists" class="tsd-anchor"></a> <h3>user<wbr>Exists</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">user<wbr>Exists<span class="tsd-signature-symbol">(</span>userId<span class="tsd-signature-symbol">: </span><a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>userId: <a href="users_and_identity.domainuserid.html" class="tsd-signature-type">DomainUserId</a></h5> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4> </li> </ul> </section> <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"> <a name="users" class="tsd-anchor"></a> <h3>users</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">users<span class="tsd-signature-symbol">(</span>users<span class="tsd-signature-symbol">: </span><a href="../modules/users_and_identity.html#domainuseridentifier" class="tsd-signature-type">DomainUserIdentifier</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.domainuser.html" class="tsd-signature-type">DomainUser</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li> </ul> <ul class="tsd-descriptions"> <li class="tsd-description"> <aside class="tsd-sources"> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Looks up multiple users at once by username or <a href="users_and_identity.domainuserid.html">DomainUserId</a>.</p> </div> </div> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameters"> <li> <h5>users: <a href="../modules/users_and_identity.html#domainuseridentifier" class="tsd-signature-type">DomainUserIdentifier</a><span class="tsd-signature-symbol">[]</span></h5> <div class="tsd-comment tsd-typography"> <p>an array of username strings, <a href="users_and_identity.domainuserid.html">DomainUserId</a>s, or any combination therein</p> </div> </li> </ul> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="users_and_identity.domainuser.html" class="tsd-signature-type">DomainUser</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4> <p>a promise which will be resolved with an array of length equal to <code>users</code>, with a <a href="users_and_identity.domainuser.html">DomainUser</a> or <code>undefined</code> for each user query</p> </li> </ul> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="globals "> <a href="../globals.html"><em>Index</em></a> </li> <li class="modules-label">Modules</li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/activities.html">Activities</a></span> </li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/chat.html">Chat</a></span> </li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/connection_and_authentication.html">Connection and <wbr>Authentication</a></span> </li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/offline.html">Offline</a></span> </li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/presence.html">Presence</a></span> </li> <li class=" tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/real_time_data.html">Real <wbr>Time <wbr>Data</a></span> </li> <li class="current tsd-kind-module"> <span class="tsd-kind-icon"><a href="../modules/users_and_identity.html">Users and <wbr>Identity</a></span> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-enum tsd-parent-kind-module"> <a href="../enums/users_and_identity.domainusertype.html" class="tsd-kind-icon">Domain<wbr>User<wbr>Type</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="users_and_identity.convergencesession.html" class="tsd-kind-icon">Convergence<wbr>Session</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="users_and_identity.domainuser.html" class="tsd-kind-icon">Domain<wbr>User</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="users_and_identity.domainuserid.html" class="tsd-kind-icon">Domain<wbr>User<wbr>Id</a> </li> <li class=" tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter"> <a href="users_and_identity.domainuseridmap.html" class="tsd-kind-icon">Domain<wbr>User<wbr>IdMap</a> </li> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-module"> <a href="users_and_identity.identityservice.html" class="tsd-kind-icon">Identity<wbr>Service</a> <ul> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="users_and_identity.identityservice.html#group" class="tsd-kind-icon">group</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="users_and_identity.identityservice.html#groups" class="tsd-kind-icon">groups</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="users_and_identity.identityservice.html#groupsforuser" class="tsd-kind-icon">groups<wbr>For<wbr>User</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="users_and_identity.identityservice.html#groupsforusers" class="tsd-kind-icon">groups<wbr>For<wbr>Users</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="users_and_identity.identityservice.html#profile" class="tsd-kind-icon">profile</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="users_and_identity.identityservice.html#search" class="tsd-kind-icon">search</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="users_and_identity.identityservice.html#session" class="tsd-kind-icon">session</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="users_and_identity.identityservice.html#user" class="tsd-kind-icon">user</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="users_and_identity.identityservice.html#userexists" class="tsd-kind-icon">user<wbr>Exists</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="users_and_identity.identityservice.html#users" class="tsd-kind-icon">users</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-parent-kind-module"> <a href="users_and_identity.usergroup.html" class="tsd-kind-icon">User<wbr>Group</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-module"> <a href="../interfaces/users_and_identity.userquery.html" class="tsd-kind-icon">User<wbr>Query</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/users_and_identity.html#domainuseridentifier" class="tsd-kind-icon">Domain<wbr>User<wbr>Identifier</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module tsd-has-type-parameter"> <a href="../modules/users_and_identity.html#domainusermapping" class="tsd-kind-icon">Domain<wbr>User<wbr>Mapping</a> </li> <li class=" tsd-kind-type-alias tsd-parent-kind-module"> <a href="../modules/users_and_identity.html#userfield" class="tsd-kind-icon">User<wbr>Field</a> </li> </ul> </nav> </div> </div> </div> <footer> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li> <li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li> <li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li> <li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li> <li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li> <li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li> <li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li> </ul> </div> </div> </footer> <div class="overlay"></div> <script src="../assets/js/main.js"></script> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','//www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-84372428-3', 'auto'); ga('send', 'pageview'); </script> </body> </html>