Skip to content
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.

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

first draft add of datasource for user grants #201

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 2 additions & 0 deletions zitadel/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -248,6 +248,8 @@ func Provider() *schema.Provider {
"zitadel_org_idp_saml": org_idp_saml.GetDatasource(),
"zitadel_org_idp_oauth": org_idp_oauth.GetDatasource(),
"zitadel_default_oidc_settings": default_oidc_settings.GetDatasource(),
"zitadel_user_grant": user_grant.GetDatasource(),
"zitadel_user_grants": user_grant.ListDatasources(),
},
Schema: map[string]*schema.Schema{
helper.DomainVar: {
Expand Down
8 changes: 8 additions & 0 deletions zitadel/user_grant/const.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,12 @@ const (
projectGrantIDVar = "project_grant_id"
UserIDVar = "user_id"
RoleKeysVar = "role_keys"
OrgNameVar = "org_name"
userNameVar = "user_name"
roleStatusVar = "role_status"
projectNameVar = "project_name"
roleNamesVar = "role_names"
userGrantDataVar = "user_grant_data"
emailVar = "email"
nameVar = "name"
)
129 changes: 129 additions & 0 deletions zitadel/user_grant/datasource.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
package user_grant

import (
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)

func GetDatasource() *schema.Resource {
return &schema.Resource{
Description: "represents role grants",
Schema: map[string]*schema.Schema{
grantIDVar: {
Type: schema.TypeString,
Required: true,
Description: "ID of the usergrant",
},
UserIDVar: {
Type: schema.TypeString,
Required: true,
Description: "ID of the user",
},
RoleKeysVar: {
Type: schema.TypeList,
Computed: true,
Description: "A set of all roles for a user.",
Elem: &schema.Schema{Type: schema.TypeString},
},
projectNameVar: {
Type: schema.TypeString,
Optional: true,
Description: "Name of the project.",
Computed: true,
},
roleStatusVar: {
Type: schema.TypeString,
Optional: true,
Description: "Status of role",
Computed: true,
},
userNameVar: {
Type: schema.TypeString,
Optional: true,
Description: "username",
Computed: true,
},
emailVar: {
Type: schema.TypeString,
Optional: true,
Description: "email of user",
Computed: true,
},
nameVar: {
Type: schema.TypeString,
Optional: true,
Description: "display name of user",
Computed: true,
},
},
ReadContext: readDS,
}
}

func ListDatasources() *schema.Resource {
return &schema.Resource{
Description: "represents role grants",
Schema: map[string]*schema.Schema{
projectNameVar: {
Type: schema.TypeString,
Required: true,
Description: "Name of the project.",
},
userGrantDataVar: {
Type: schema.TypeList,
Computed: true,
Description: "A list of all usergrants.",
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
grantIDVar: {
Type: schema.TypeString,
Computed: true,
Description: "grantID",
},
UserIDVar: {
Type: schema.TypeString,
Computed: true,
Description: "userid",
},
RoleKeysVar: {
Type: schema.TypeList,
Computed: true,
Description: "A set of all roles for a user.",
Elem: &schema.Schema{Type: schema.TypeString},
},
projectNameVar: {
Type: schema.TypeString,
Optional: true,
Description: "Name of the project.",
Computed: true,
},
roleStatusVar: {
Type: schema.TypeString,
Optional: true,
Description: "Status of role",
Computed: true,
},
userNameVar: {
Type: schema.TypeString,
Optional: true,
Description: "username",
Computed: true,
},
emailVar: {
Type: schema.TypeString,
Optional: true,
Description: "email of user",
Computed: true,
},
nameVar: {
Type: schema.TypeString,
Optional: true,
Description: "display name of user",
Computed: true,
},
},
},
},
},
ReadContext: list,
}
}
84 changes: 84 additions & 0 deletions zitadel/user_grant/funcs.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/zitadel/zitadel-go/v3/pkg/client/zitadel/management"
"github.com/zitadel/zitadel-go/v3/pkg/client/zitadel/user"

"github.com/zitadel/terraform-provider-zitadel/v2/zitadel/helper"
)
Expand Down Expand Up @@ -125,3 +126,86 @@ func read(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagn
d.SetId(grant.GetId())
return nil
}

func readDS(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
tflog.Info(ctx, "started read")
clientinfo, ok := m.(*helper.ClientInfo)
if !ok {
return diag.Errorf("failed to get client")
}
client, err := helper.GetManagementClient(ctx, clientinfo)
if err != nil {
return diag.FromErr(err)
}
resp, err := client.GetUserGrantByID(helper.CtxWithOrgID(ctx, d), &management.GetUserGrantByIDRequest{
GrantId: helper.GetID(d, grantIDVar),
UserId: d.Get(UserIDVar).(string),
})
if err != nil && helper.IgnoreIfNotFoundError(err) == nil {
d.SetId("")
return nil
}
if err != nil {
return diag.Errorf("failed to get user grant")
}
grant := resp.GetUserGrant()
set := map[string]interface{}{
UserIDVar: grant.GetUserId(),
RoleKeysVar: grant.GetRoleKeys(),
userNameVar: grant.GetUserName(),
roleStatusVar: grant.GetState().String(),
projectNameVar: grant.GetProjectName(),
emailVar: grant.Email,
nameVar: grant.DisplayName,
projectIDVar: grant.GetProjectId(),
projectGrantIDVar: grant.GetProjectGrantId(),
}
for k, v := range set {
if err := d.Set(k, v); err != nil {
return diag.Errorf("failed to set %s of usergrant: %v", k, err)
}
}
d.SetId(grant.GetId())
return nil
}
func list(ctx context.Context, d *schema.ResourceData, m interface{}) diag.Diagnostics {
tflog.Info(ctx, "started list")
projectName := d.Get(projectNameVar).(string)
clientinfo, ok := m.(*helper.ClientInfo)
if !ok {
return diag.Errorf("failed to get client")
}
client, err := helper.GetManagementClient(ctx, clientinfo)
if err != nil {
return diag.FromErr(err)
}
req := &management.ListUserGrantRequest{}
req.Queries = append(req.Queries, &user.UserGrantQuery{
Query: &user.UserGrantQuery_ProjectNameQuery{
ProjectNameQuery: &user.UserGrantProjectNameQuery{
ProjectName: projectName,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is only the projectName used as a query? It is even listed as computed, I would rather use other identifiers first, and maybe provide the name later.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i am using projectName as the query because that is my current use case, i need to lookup the user grants by project name. Feel free to make it more generic or point me to an example of how you want it done.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good to me for the start, normally I would at least add the identifier of the project itself as a base query.
Have a look at the application_saml resouce as an example.

Method: 3,
},
},
})
resp, err := client.ListUserGrants(ctx, req)
if err != nil {
return diag.Errorf("error while getting roles by projName %s: %v", projectName, err)
}
results := []map[string]interface{}{}
for _, roleGrant := range resp.Result {
results = append(results, map[string]interface{}{
UserIDVar: roleGrant.UserId,
grantIDVar: roleGrant.Id,
RoleKeysVar: roleGrant.GetRoleKeys(),
userNameVar: roleGrant.GetUserName(),
roleStatusVar: roleGrant.GetState().String(),
projectNameVar: roleGrant.GetProjectName(),
emailVar: roleGrant.Email,
nameVar: roleGrant.DisplayName,
})
}
// If the ID is blank, the datasource is deleted and not usable.
d.SetId("-")
return diag.FromErr(d.Set(userGrantDataVar, results))
}