AuthClient
@tribeplatform/gql-client / Modules / clients / AuthClient
Class: AuthClient#
clients.AuthClient
Table of contents#
Constructors#
Methods#
- authMember
- confirmResetPassword
- joinNetwork
- joinNetworkWithInvitationLink
- joinNetworkWithToken
- login
- loginWithSso
- logout
- resendVerification
- sendResetPasswordEmail
- ssoMemberships
- ssoRedirect
- ssoUrl
- ssos
- updateCustomSso
- updateDefaultSsoStatus
- updatePasswordWithToken
- verifyMember
Constructors#
constructor#
• new AuthClient(client)
Parameters#
| Name | Type |
|---|---|
client | GraphqlClient |
Defined in#
packages/client/src/clients/auth.client.ts:52
Methods#
authMember#
▸ authMember(fields?): Promise<Member>
Parameters#
| Name | Type | Default value |
|---|---|---|
fields | MemberFields | 'basic' |
Returns#
Promise<Member>
Defined in#
packages/client/src/clients/auth.client.ts:88
confirmResetPassword#
▸ confirmResetPassword(variables, accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationConfirmResetPasswordArgs |
accessToken? | string |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/auth.client.ts:233
joinNetwork#
▸ joinNetwork(variables, fields?): Promise<AuthToken>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationJoinNetworkArgs | undefined |
fields | AuthTokenFields | 'basic' |
Returns#
Promise<AuthToken>
Defined in#
packages/client/src/clients/auth.client.ts:117
joinNetworkWithInvitationLink#
▸ joinNetworkWithInvitationLink(variables, fields?): Promise<AuthToken>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationJoinNetworkWithInvitationLinkArgs | undefined |
fields | AuthTokenFields | 'basic' |
Returns#
Promise<AuthToken>
Defined in#
packages/client/src/clients/auth.client.ts:129
joinNetworkWithToken#
▸ joinNetworkWithToken(variables, fields?): Promise<AuthToken>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationJoinNetworkWithTokenArgs | undefined |
fields | AuthTokenFields | 'basic' |
Returns#
Promise<AuthToken>
Defined in#
packages/client/src/clients/auth.client.ts:141
login#
▸ login(variables, fields?): Promise<AuthToken>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | QueryLoginNetworkArgs | undefined |
fields | AuthTokenFields | 'basic' |
Returns#
Promise<AuthToken>
Defined in#
packages/client/src/clients/auth.client.ts:65
loginWithSso#
▸ loginWithSso(variables): Promise<SsoUrl>
Parameters#
| Name | Type |
|---|---|
variables | QueryLoginWithSsoArgs |
Returns#
Promise<SsoUrl>
Defined in#
packages/client/src/clients/auth.client.ts:96
logout#
▸ logout(variables): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationLogoutNetworkArgs |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/auth.client.ts:77
resendVerification#
▸ resendVerification(accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
accessToken? | string |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/auth.client.ts:56
sendResetPasswordEmail#
▸ sendResetPasswordEmail(variables, accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationSendResetPasswordEmailArgs |
accessToken? | string |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/auth.client.ts:174
ssoMemberships#
▸ ssoMemberships(variables): Promise<SsoMembership[]>
Parameters#
| Name | Type |
|---|---|
variables | QuerySsoMembershipsArgs |
Returns#
Promise<SsoMembership[]>
Defined in#
packages/client/src/clients/auth.client.ts:213
ssoRedirect#
▸ ssoRedirect(variables, fields?): Promise<AuthToken>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationSsoRedirectArgs | undefined |
fields | AuthTokenFields | 'basic' |
Returns#
Promise<AuthToken>
Defined in#
packages/client/src/clients/auth.client.ts:105
ssoUrl#
▸ ssoUrl(variables): Promise<SsoUrl>
Parameters#
| Name | Type |
|---|---|
variables | QuerySsoUrlArgs |
Returns#
Promise<SsoUrl>
Defined in#
packages/client/src/clients/auth.client.ts:224
ssos#
▸ ssos(variables): Promise<Sso[]>
Parameters#
| Name | Type |
|---|---|
variables | QuerySsosArgs |
Returns#
Promise<Sso[]>
Defined in#
packages/client/src/clients/auth.client.ts:165
updateCustomSso#
▸ updateCustomSso(variables, accessToken?): Promise<Sso>
Parameters#
| Name | Type |
|---|---|
variables | MutationUpdateCustomSsoArgs |
accessToken? | string |
Returns#
Promise<Sso>
Defined in#
packages/client/src/clients/auth.client.ts:187
updateDefaultSsoStatus#
▸ updateDefaultSsoStatus(variables, accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationUpdateDefaultSsoStatusArgs |
accessToken? | string |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/auth.client.ts:200
updatePasswordWithToken#
▸ updatePasswordWithToken(variables, accessToken?): Promise<Action>
Parameters#
| Name | Type |
|---|---|
variables | MutationUpdatePasswordWithTokenArgs |
accessToken? | string |
Returns#
Promise<Action>
Defined in#
packages/client/src/clients/auth.client.ts:246
verifyMember#
▸ verifyMember(variables, fields?): Promise<AuthToken>
Parameters#
| Name | Type | Default value |
|---|---|---|
variables | MutationVerifyMemberArgs | undefined |
fields | AuthTokenFields | 'basic' |
Returns#
Promise<AuthToken>