Skip to content

Commit b78f858

Browse files
marythoughtclaude
andcommitted
chore(docs): use EntityIdentifiers namespace for JS examples
Update JS examples to use `EntityIdentifiers.forEmail(...)` instead of bare `forEmail(...)` to match opentdf/web-sdk#916. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent de4fa15 commit b78f858

2 files changed

Lines changed: 27 additions & 27 deletions

File tree

docs/sdks/authorization.mdx

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -131,17 +131,17 @@ EntityIdentifier.newBuilder()
131131

132132
| Helper | Description |
133133
|--------|-------------|
134-
| `forEmail(email)` | Identify by email address |
135-
| `forClientId(clientId)` | Identify by client ID (service account / NPE) |
136-
| `forUserName(username)` | Identify by username |
137-
| `forToken(jwt)` | Resolve entity from a JWT token |
138-
| `withRequestToken()` | Derive entity from the request's Authorization header |
134+
| `EntityIdentifiers.forEmail(email)` | Identify by email address |
135+
| `EntityIdentifiers.forClientId(clientId)` | Identify by client ID (service account / NPE) |
136+
| `EntityIdentifiers.forUserName(username)` | Identify by username |
137+
| `EntityIdentifiers.forToken(jwt)` | Resolve entity from a JWT token |
138+
| `EntityIdentifiers.withRequestToken()` | Derive entity from the request's Authorization header |
139139

140140
```typescript
141-
import { forEmail } from '@opentdf/sdk';
141+
import { EntityIdentifiers } from '@opentdf/sdk';
142142

143143
const response = await platformClient.v2.authorization.getDecision({
144-
entityIdentifier: forEmail('alice@example.com'),
144+
entityIdentifier: EntityIdentifiers.forEmail('alice@example.com'),
145145
// ...
146146
});
147147
```
@@ -179,11 +179,11 @@ const response = await platformClient.v2.authorization.getDecision({
179179

180180
| Type | Go | Java | JavaScript |
181181
|------|-----|------|------------|
182-
| Email | `ForEmail(email)` | `forEmail(email)` | `forEmail(email)` |
183-
| Client ID | `ForClientID(id)` | `forClientId(id)` | `forClientId(id)` |
184-
| Username | `ForUserName(name)` | `forUserName(name)` | `forUserName(name)` |
185-
| JWT Token | `ForToken(jwt)` | `forToken(jwt)` | `forToken(jwt)` |
186-
| Request Token | `WithRequestToken()` || `withRequestToken()` |
182+
| Email | `ForEmail(email)` | `EntityIdentifiers.forEmail(email)` | `EntityIdentifiers.forEmail(email)` |
183+
| Client ID | `ForClientID(id)` | `forClientId(id)` | `EntityIdentifiers.forClientId(id)` |
184+
| Username | `ForUserName(name)` | `forUserName(name)` | `EntityIdentifiers.forUserName(name)` |
185+
| JWT Token | `ForToken(jwt)` | `forToken(jwt)` | `EntityIdentifiers.forToken(jwt)` |
186+
| Request Token | `WithRequestToken()` || `EntityIdentifiers.withRequestToken()` |
187187

188188
---
189189

@@ -221,7 +221,7 @@ await platformClient.v2.authorization.getEntitlements({ ... })
221221

222222
| Parameter | Type | Required | Description |
223223
|-----------|------|----------|-------------|
224-
| `entityIdentifier` | `EntityIdentifier` | Yes | The entity to query. Use [helpers](#entityidentifier) like `ForEmail(...)` (Go), `EntityIdentifiers.forEmail(...)` (Java), or `forEmail(...)` (JS). |
224+
| `entityIdentifier` | `EntityIdentifier` | Yes | The entity to query. Use [helpers](#entityidentifier) like `ForEmail(...)` (Go), `EntityIdentifiers.forEmail(...)` (Java), or `EntityIdentifiers.forEmail(...)` (JS). |
225225
| `withComprehensiveHierarchy` | `bool` | No | When true, returns all entitled values for attributes with hierarchy rules, propagating down from the entitled value. |
226226

227227
**Example**
@@ -345,10 +345,10 @@ for (EntityEntitlements entitlement : resp.getEntitlementsList()) {
345345
<TabItem value="js" label="JavaScript">
346346

347347
```typescript
348-
import { forEmail } from '@opentdf/sdk';
348+
import { EntityIdentifiers } from '@opentdf/sdk';
349349

350350
const response = await platformClient.v2.authorization.getEntitlements({
351-
entityIdentifier: forEmail('bob@OrgA.com'),
351+
entityIdentifier: EntityIdentifiers.forEmail('bob@OrgA.com'),
352352
});
353353

354354
for (const entitlement of response.entitlements) {
@@ -359,10 +359,10 @@ for (const entitlement of response.entitlements) {
359359
To expand hierarchy rules:
360360

361361
```typescript
362-
import { forEmail } from '@opentdf/sdk';
362+
import { EntityIdentifiers } from '@opentdf/sdk';
363363

364364
const response = await platformClient.v2.authorization.getEntitlements({
365-
entityIdentifier: forEmail('user@company.com'),
365+
entityIdentifier: EntityIdentifiers.forEmail('user@company.com'),
366366
withComprehensiveHierarchy: true,
367367
});
368368

@@ -412,7 +412,7 @@ await platformClient.v2.authorization.getDecision({ ... })
412412

413413
| Parameter | Type | Required | Description |
414414
|-----------|------|----------|-------------|
415-
| `entityIdentifier` | `EntityIdentifier` | Yes | The entity requesting access. Use [helpers](#entityidentifier) like `ForEmail(...)` (Go), `EntityIdentifiers.forEmail(...)` (Java), or `forEmail(...)` (JS). |
415+
| `entityIdentifier` | `EntityIdentifier` | Yes | The entity requesting access. Use [helpers](#entityidentifier) like `ForEmail(...)` (Go), `EntityIdentifiers.forEmail(...)` (Java), or `EntityIdentifiers.forEmail(...)` (JS). |
416416
| `action` | `Action` | Yes | The action being performed (e.g., `decrypt`, `read`). |
417417
| `resource` | `Resource` | Yes | The resource being accessed, identified by attribute value FQNs. |
418418

@@ -586,11 +586,11 @@ if (decision.getDecision() == Decision.DECISION_PERMIT) {
586586
<TabItem value="js" label="JavaScript">
587587

588588
```typescript
589-
import { forEmail } from '@opentdf/sdk';
589+
import { EntityIdentifiers } from '@opentdf/sdk';
590590
import { Decision } from '@opentdf/sdk/platform/authorization/v2/authorization_pb.js';
591591

592592
const response = await platformClient.v2.authorization.getDecision({
593-
entityIdentifier: forEmail('user@company.com'),
593+
entityIdentifier: EntityIdentifiers.forEmail('user@company.com'),
594594
action: { name: 'decrypt' },
595595
resource: {
596596
resource: {
@@ -828,12 +828,12 @@ import GetDecisionsExample from '@site/code_samples/java/get-decisions.mdx';
828828
<TabItem value="js" label="JavaScript">
829829

830830
```typescript
831-
import { forEmail } from '@opentdf/sdk';
831+
import { EntityIdentifiers } from '@opentdf/sdk';
832832

833833
const response = await platformClient.v2.authorization.getDecisionBulk({
834834
decisionRequests: [
835835
{
836-
entityIdentifier: forEmail('user@company.com'),
836+
entityIdentifier: EntityIdentifiers.forEmail('user@company.com'),
837837
action: { name: 'decrypt' },
838838
resources: [
839839
{

docs/sdks/discovery.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -582,13 +582,13 @@ Entity.newBuilder().setId("e1").setUuid("550e8400-e29b-41d4-a716-446655440000").
582582
<TabItem value="js" label="JavaScript">
583583
584584
```typescript
585-
import { forEmail } from '@opentdf/sdk';
585+
import { EntityIdentifiers } from '@opentdf/sdk';
586586
import { PlatformClient } from '@opentdf/sdk/platform';
587587

588588
const platform = new PlatformClient({ ...auth, platformUrl });
589589

590590
const resp = await platform.v2.authorization.getEntitlements({
591-
entityIdentifier: forEmail('alice@example.com'),
591+
entityIdentifier: EntityIdentifiers.forEmail('alice@example.com'),
592592
});
593593

594594
if (resp.entitlements.length > 0) {
@@ -599,10 +599,10 @@ if (resp.entitlements.length > 0) {
599599
Other supported [entity identifier helpers](/sdks/authorization#entityidentifier):
600600

601601
```typescript
602-
import { forUserName, forClientId } from '@opentdf/sdk';
602+
import { EntityIdentifiers } from '@opentdf/sdk';
603603

604-
forUserName('alice') // By username
605-
forClientId('my-service') // By client ID (NPE / service account)
604+
EntityIdentifiers.forUserName('alice') // By username
605+
EntityIdentifiers.forClientId('my-service') // By client ID (NPE / service account)
606606
```
607607

608608
</TabItem>

0 commit comments

Comments
 (0)