Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 1.35 KB

README.md

File metadata and controls

55 lines (35 loc) · 1.35 KB
Raw

audiences

audiences is a SCIM-integrated UI to create criteria based on SCIM groups and users.

Usage

Creating/Managing audiences

The AudienceEditor component is the main entry point. It requires an uri, which is the audience context URI (see Managing/Audiences) and a SCIM backend URI, which can be the Audience::ScimProxy or the SCIM endpoint – with a properly configured CORS to accept external calls.

With everything in place, the usage should look like this:

<AudienceEditor uri={audienceContextUri} scimUri={scimV2Uri} />

You can also add arguments to the fetch calls, like headers:

<AudienceEditor
  uri={audienceContextUri}
  scimUri={scimV2Uri}
  fetchOptions={{ headers: { Authorization: "Bearer my-token" } }}
/>

See example.

Peer Dependencies

Audiences assumes three peer dependencies are configured:

  • React
  • ReactDOM
  • playbook-ui

Installation

yarn add audiences

Or

npm i -S audiences

Contributing

See development guide.

License

The gem is available as open source under the terms of the MIT License.