users-and-access · FinBaze for Platforms

Components

Kind: view (fills its container) · Session key: usersAndAccess · React: <FinBazeUsersAndAccess />

Create the session#

mutation {
  createEmbedSession(input: {
    companyId: "…"
    user: { externalUserId: "…" }
    components: { usersAndAccess: { enabled: true } }
  }) { clientSecret }
}

Requirements#

No feature requirements.

Component features#

Switch these off per session with components.usersAndAccess.features.

Feature	Default
`invite`	on
`changeRole`	on
`remove`	on

Options#

Only the common options: appearance and navigation ("internal" or "external").

Events#

Event	React prop
`ready`	`onReady`
`navigate`	`onNavigate`
`error`	`onError`
`user.invite_requested`	`onUserInviteRequested`
`user.role_change_requested`	`onUserRoleChangeRequested`
`user.removal_requested`	`onUserRemovalRequested`

Use it#

import { FinBazeUsersAndAccess } from "@finbaze/embed-react";

<FinBazeUsersAndAccess />

const component = instance.create("users-and-access");
component.mount("#finbaze");