Skip to content

chore(docs): add Resource constructor helpers and update examples #301

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
marythought merged 9 commits into from
Apr 24, 2026
Merged

chore(docs): add Resource constructor helpers and update examples #301

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7e9a00e
fix(docs): Go setup compilability and manual EntityIdentifier example
marythought Apr 22, 2026
08c0d18
chore(docs): add Resource constructor helpers and update examples
marythought Apr 21, 2026
45ae9d5
chore(docs): address review feedback on Resource helpers
marythought Apr 21, 2026
af074e2
chore(docs): add SdkVersion annotations to Resource helpers
marythought Apr 22, 2026
c15945a
chore(docs): add TDFObject type reference and link from CreateTDF Ret…
marythought Apr 22, 2026
e1f2f90
chore(docs): link EntityIdentifier and Resource types in parameter ta…
marythought Apr 22, 2026
a6c255b
fix(docs): define ctx in Go setup blocks instead of blank assignment
marythought Apr 22, 2026
25fb4ea
Merge branch 'main' into chore/resource-constructor-docs
marythought Apr 24, 2026
4634556
chore(docs): fix duplicate details block, client variable, and type o…
marythought Apr 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 14 additions & 54 deletions code_samples/authorization/get_decision.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,16 @@ func main() {

// Get Decision using v2 API
// Convenience constructors live in the authorization/v2 package:
// ForClientID, ForEmail, ForUserName, ForToken, WithRequestToken
// Entity: ForClientID, ForEmail, ForUserName, ForToken, WithRequestToken
// Resource: ForAttributeValues, ForRegisteredResourceValueFqn
decisionReq := &authorization.GetDecisionRequest{
EntityIdentifier: authorization.ForClientID("opentdf"),
Action: &policy.Action{
Name: "decrypt",
},
Resource: &authorization.Resource{
Resource: &authorization.Resource_AttributeValues_{
AttributeValues: &authorization.Resource_AttributeValues{
Fqns: []string{"https://opentdf.io/attr/role/value/developer"},
},
},
},
Resource: authorization.ForAttributeValues(
Comment thread
marythought marked this conversation as resolved.
"https://opentdf.io/attr/role/value/developer",
),
}

decision, err := client.AuthorizationV2.GetDecision(context.Background(), decisionReq)
Expand Down Expand Up @@ -141,7 +138,6 @@ import io.opentdf.platform.sdk.*;
import java.util.concurrent.ExecutionException;

import io.opentdf.platform.authorization.*;
import io.opentdf.platform.entity.*;
import io.opentdf.platform.policy.*;

public class GetDecision {
Expand All @@ -158,28 +154,13 @@ public class GetDecision {

// Get Decision using v2 API
GetDecisionRequest request = GetDecisionRequest.newBuilder()
.setEntityIdentifier(
EntityIdentifier.newBuilder()
.setEntityChain(
EntityChain.newBuilder()
.addEntities(
Entity.newBuilder()
.setId("entity-1")
.setClientId("opentdf")
)
)
)
.setEntityIdentifier(EntityIdentifiers.forClientId("opentdf"))
.setAction(
Action.newBuilder()
.setName("decrypt")
)
.setResource(
Resource.newBuilder()
.setAttributeValues(
Resource.AttributeValues.newBuilder()
.addFqns("https://opentdf.io/attr/role/value/developer")
)
)
.setResource(Resources.forAttributeValues(
"https://opentdf.io/attr/role/value/developer"))
.build();

GetDecisionResponse resp = sdk.getServices().authorization().getDecision(request).get();
Expand All @@ -202,6 +183,7 @@ public class GetDecision {
import {
Decision,
} from "@opentdf/sdk/platform/authorization/v2/authorization_pb.js";
import { EntityIdentifiers, Resources } from "@opentdf/sdk";
import { platformConnect, PlatformClient } from "@opentdf/sdk/platform";

async function main() {
Expand All @@ -223,33 +205,11 @@ async function main() {
// Get Decision using v2 API
try {
const response = await platformClient.v2.authorization.getDecision({
entityIdentifier: {
identifier: {
case: "entityChain",
value: {
entities: [
{
ephemeralId: "entity-1",
entityType: {
case: "clientId",
value: "opentdf",
},
},
],
},
},
},
action: {
name: "decrypt",
},
resource: {
resource: {
case: "attributeValues",
value: {
fqns: ["https://opentdf.io/attr/role/value/developer"],
},
},
},
entityIdentifier: EntityIdentifiers.forClientId("opentdf"),
action: { name: "decrypt" },
resource: Resources.forAttributeValues(
"https://opentdf.io/attr/role/value/developer",
),
});

const decision = response.decision;
Expand Down
Loading
Loading