Skip to main content

Identity Provider Mapper API

IdentityProviderMapperHandle manages mappers that belong to a specific identity provider.

Access​

const mapper = realm.identityProvider('google').mapper('email-mapper');

Common Lifecycle​

await realm
  .identityProvider('google')
  .mapper('email-mapper')
  .ensure({
    identityProviderMapper: 'oidc-user-attribute-idp-mapper',
    config: {
      claim: 'email',
      'user.attribute': 'email',
    },
  });

Methods​

  • get() and getById(id)
  • create(data)
  • update(data)
  • delete()
  • ensure(data)
  • discard()

The handle resolves the parent identity provider lazily, so you can build it from realm.identityProvider(alias) without preloading that provider first.