@vendasta/iam 2.0.2 → 2.2.2

package/CHANGELOG.md

@@ -0,0 +1,101 @@
+# Changelog
+
+## 2.2.2
+- Change ng-package location in IAM_SDK
+
+## 2.2.1
+- Version Bump (Doesn't change anything)
+
+## 2.2.0
+- Regenerated TS SDK
+
+## 2.1.0
+- Add canAccessRetailBilling to PartnerPersona
+
+## 2.0.2
+- Fix ssoLogin() query param encoding
+
+## 2.0.1
+- Set defaults for partner 'canAccess*' attributes to false, as they should be filled in by the actual persona's attributes. This will affect the values of these fields for partner users who don't have values for these attributes, but the new behaviour matches the actual values stored in IAM.
+
+## 2.0.0
+- Tree Shakeable
+
+## 1.17.2
+- Rebuild SDK integrity check error with the last version.
+
+## 1.17.1
+- Fix TS SDK.
+
+## 1.17.0
+- Add ListUser sorting by LastLoginColumn
+
+## 1.16.0
+- Add canAccessAutomations to PartnerPersona
+
+## 1.15.2
+- Add account_group PersonaType
+
+## 1.14.0
+- Add `profilePicture` to DigitalAgent
+
+## 1.13.0
+- Expose HostService so that external users can override environment if needed
+
+## 1.12.0
+- Add `DeleteUser`
+
+## 1.11.0
+- Add `AddMultiUserRestriction`
+- Add `RemoveMultiUserRestriction`
+- Add `CreateExternalID`
+- Add `GetMultiExternalID`
+- Add user Identifier to `AddKey` and `RemoveKey`
+- Return public_keys on User
+
+## 1.10.1
+- Fix sessionID not being returned during `login`
+  - Microservice returns object with key `session_id` not `sessionId`
+
+## 1.10.0
+- Updated ListUsers endpoint with search and sort.
+
+## 1.9.0
+- Add additional fields to the Partner Persona that are already in the attributes.
+
+## 1.8.0
+- Expose the fromPersona method in the SDK
+
+## 1.7.0
+- Add new Token UserIdentifier
+
+## 1.6.0
+- Updated the SDK with addition of roles to the Users returned in ListUsers
+
+## 1.5.0
+- Add algorithm type to AddKey, add client_key option on GetSessionForUser
+
+## 1.4.1
+- Fix serializing namespace on ListUsers
+
+## 1.4.0
+- Add UserFilter to the ListUsers function
+
+## 1.3.1 
+- Add userId to BasePersona
+
+## 1.3.0
+- Add listUsers function to IAMService
+
+## 1.2.1
+- Fix null injector error by providing IamHttpApiService
+
+## 1.2.0
+- Add listSecurityLogs function to IAMService
+
+## 1.1.0
+- Add getMultiUser function to IAMService
+
+## 1.0.0
+- Transferred package from [vendasta/core](https://github.com/vendasta/frontend/blob/master/angular/projects/core/iam/CHANGELOG.md)
+- See that changelog for any prior changes

package/README.md

@@ -0,0 +1,113 @@
+# IAM SDK
+
+## Login
+`login(email: string, password: string, personaType?: PersonaType, partnerId?: string): Observable<string>`
+
+Login accepts an email and password to use to attempt to auth a user. If `personaType` isn't specified, IAM will attempt to
+auth the email and password combo against any of the associated personas. If `personaType` and optionally `partnerId` are
+specified, IAM will auth against that persona specifically.
+
+## Logout
+`logout(): Observable<boolean>`
+
+Logout will clear the user's cookies on IAM's side. Returns true if successful.
+
+## SSO Login
+`ssoLogin(nextUrl: string, personaType: PersonaType, partnerId?: string): void`
+
+SSOLogin will redirect the user's browser to IAM's SSOLogin page. IAM handles all of the oauth google has in place for
+getting a session using your gmail account (and the whitelabeling of the domain requesting access). Once IAM is done
+handling those requests, IAM will then attempt to find the persona specified in this endpoint (the `personaType` and
+`partnerId` combination). If IAM fails to find a persona, it will redirect to the `nextUrl` with `error` and `status`
+query params indicating why it failed. If IAM is successful in finding the appropriate persona for the request, it
+will redirect to the `nextUrl` with a `session_id` query param. You will then have to take this `session_id` and set up
+the user's session with it, in the same fashion you would have set up the session from the response of the `Login`
+endpoint.
+
+## Get Subject By Session
+`getSubjectBySession(sessionId: string, personaType: PersonaType, partnerId?: string): Observable<BasePersona>`
+
+Specify the `personaType` and optionally the `partnerId` for the persona you'd like to retrieve using the `sessionId`.
+This endpoint returns a `BasePersona` which is the base class that all Personas inherit. To gain access to the attributes
+of a specific persona, you will need to cast the persona as the requested type.
+
+```typescript
+import {BasePersona, PartnerPersona, PersonaType} from '@vendasta/core/iam'
+
+this.iamClient.getSubjectBySession('...sessionId...', PersonaType.partner)
+  .map((persona: BasePersona) => persona as PartnerPersona)
+  .subscribe(...)
+```
+
+## Get Logged In Subject
+`getLoggedInSubject(personaType: PersonaType, partnerId?: string): Observable<BasePersona>`
+
+Works identically to getSubjectBySession except it grabs the current session being served by the SessionService.
+
+## List Personas
+`listPersonas(sessionId: string, personaType?: PersonaType): Observable<BasePersona[]>`
+
+Given a `sessionId`, listPersonas will find and return all available personas for the session. Optionally specify a
+`personaType` to filter the results by only that type of persona. List personas will return a list of all the personas
+it found. This endpoint returns `BasePersona` and thus they will need to be casted to their appropriate PersonaTypes to
+gain access to the attributes.
+
+```typescript
+import {BasePersona, PartnerPersona, PersonaType, SMBPersona} from '@vendasta/core/iam'
+
+this.iamClient.listPersonas('...sessionId...')
+  .subscribe((personas: BasePersona[]) => {
+    for (const persona of personas) {
+      switch(persona.type) {
+        case PartnerType.partner:
+          const p: PartnerPersona = (persona as PartnerPersona);
+          ...
+          break;
+        case PartnerType.smb:
+          const p: SMBPersona = (persona as SMBPersona);
+          ...
+          break;
+        ...
+      }
+    }
+  });
+```
+
+## List Logged In Personas
+`listLoggedInPersonas(personaType?: PersonaType): Observable<BasePersona[]>`
+
+Works identically to listPersonas except it grabs the current session being served by the SessionService.
+
+## Get Token
+`getToken(): Observable<string>`
+
+Get token will refresh the 30 minute temporary session a user may have, returning the new `sessionId`.
+
+## Get Multi Users
+
+`getMultiUsers(userIdentifiers: UserIdentifierInterface[]): Observable<User[]>`
+
+This function takes in an array of user identifiers and converts them (via API) into their respective Users that
+are stored in IAM. UserIdentifiers are an object containing one of the following:
+
+userId - the user id of a user. This directly identifies the user in our system.
+token - a token for a user signed by the platform. These tokens include: the session token from IAM (i.e. the `session` part of the `namespaced_session` UserIdentifier), as well as access token or identity tokens from SSO.
+
+Deprecated identifiers:
+namespacedEmail - an email address scoped to a namespace. A namespace is the id of a partner. Prefer to use user id instead, to avoid handling emails and for a more stable user identifier
+namespacedSession - a session string scoped to a namespace. Use token instead, as sesson is valid token, and namespace is ignored.
+
+## List security logs
+
+`listSecurityLogs(userId: string, cursor?: string, pageSize?: number, actionId = ''): Observable<ListSecurityLogsResponse>`
+
+This function returns security logs for a userId passed in. This is a paged function, but the handling of paged
+information is left to the implementor (for now). Use the cursor to call this function again and retrieve a new
+observable of the response to your call.
+
+## List Users
+
+`listUsers(namespace: string, email?: string, cursor?: string, pageSize?: number): Observable<ListUsersResponse>`
+
+ListUsers returns users for a namespace passed in. This is a paged function, but the handling of paged information
+is left to the implementor (for now). An empty namespace will return users that exist outside of a namespace.