Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add "auth0_clients" data source for listing multiple clients with fil…
…tering
- Loading branch information
1 parent
10b2331
commit a4efad3
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| page_title: "Data Source: auth0_clients" | ||
| description: |- | ||
| Data source to retrieve a list of Auth0 application clients with optional filtering. | ||
| --- | ||
|
|
||
| # Data Source: auth0_clients | ||
|
|
||
| Data source to retrieve a list of Auth0 application clients with optional filtering. | ||
|
|
||
|
|
||
|
|
||
| <!-- schema generated by tfplugindocs --> | ||
| ## Schema | ||
|
|
||
| ### Optional | ||
|
|
||
| - `app_types` (Set of String) Filter clients by application types. | ||
| - `is_first_party` (Boolean) Filter clients by first party status. | ||
| - `name_filter` (String) Filter clients by name (partial matches supported). | ||
|
|
||
| ### Read-Only | ||
|
|
||
| - `clients` (List of Object) List of clients matching the filter criteria. (see [below for nested schema](#nestedatt--clients)) | ||
| - `id` (String) The ID of this resource. | ||
|
|
||
| <a id="nestedatt--clients"></a> | ||
| ### Nested Schema for `clients` | ||
|
|
||
| Read-Only: | ||
|
|
||
| - `allowed_clients` (List of String) | ||
| - `allowed_logout_urls` (List of String) | ||
| - `allowed_origins` (List of String) | ||
| - `app_type` (String) | ||
| - `callbacks` (List of String) | ||
| - `client_id` (String) | ||
| - `client_metadata` (Map of String) | ||
| - `client_secret` (String) | ||
| - `description` (String) | ||
| - `grant_types` (List of String) | ||
| - `is_first_party` (Boolean) | ||
| - `is_token_endpoint_ip_header_trusted` (Boolean) | ||
| - `name` (String) | ||
| - `web_origins` (List of String) | ||
|
|
||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| package clients | ||
|
|
||
| import ( | ||
| "context" | ||
| "crypto/sha256" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/auth0/go-auth0/management" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/diag" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" | ||
| "github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation" | ||
|
|
||
| "github.com/auth0/terraform-provider-auth0/internal/auth0/client" | ||
| "github.com/auth0/terraform-provider-auth0/internal/config" | ||
| ) | ||
|
|
||
| // NewDataSource will return a new auth0_clients data source. | ||
| func NewDataSource() *schema.Resource { | ||
| return &schema.Resource{ | ||
| ReadContext: readClientsForDataSource, | ||
| Description: "Data source to retrieve a list of Auth0 application clients with optional filtering.", | ||
| Schema: map[string]*schema.Schema{ | ||
| "name_filter": { | ||
| Type: schema.TypeString, | ||
| Optional: true, | ||
| Description: "Filter clients by name (partial matches supported).", | ||
| }, | ||
| "app_types": { | ||
| Type: schema.TypeSet, | ||
| Optional: true, | ||
| Description: "Filter clients by application types.", | ||
| Elem: &schema.Schema{ | ||
| Type: schema.TypeString, | ||
| ValidateFunc: validation.StringInSlice(client.ValidAppTypes, false), | ||
| }, | ||
| }, | ||
| "is_first_party": { | ||
| Type: schema.TypeBool, | ||
| Optional: true, | ||
| Description: "Filter clients by first party status.", | ||
| }, | ||
| "clients": { | ||
| Type: schema.TypeList, | ||
| Computed: true, | ||
| Description: "List of clients matching the filter criteria.", | ||
| Elem: &schema.Resource{ | ||
| Schema: CoreClientDataSourceSchema(), | ||
| }, | ||
| }, | ||
| }, | ||
| } | ||
| } | ||
|
|
||
| func CoreClientDataSourceSchema() map[string]*schema.Schema { | ||
| clientSchema := client.NewDataSource().Schema | ||
|
|
||
| // Remove unused fields from the client schema | ||
| fieldsToRemove := []string{ | ||
| "client_aliases", | ||
| "logo_uri", | ||
| "oidc_conformant", | ||
| "oidc_backchannel_logout_urls", | ||
| "organization_usage", | ||
| "organization_require_behavior", | ||
| "cross_origin_auth", | ||
| "cross_origin_loc", | ||
| "custom_login_page_on", | ||
| "custom_login_page", | ||
| "form_template", | ||
| "require_pushed_authorization_requests", | ||
| "mobile", | ||
| "initiate_login_uri", | ||
| "native_social_login", | ||
| "refresh_token", | ||
| "signing_keys", | ||
| "encryption_key", | ||
| "sso", | ||
| "sso_disabled", | ||
| "jwt_configuration", | ||
| "addons", | ||
| "default_organization", | ||
| "compliance_level", | ||
| "require_proof_of_possession", | ||
| "token_endpoint_auth_method", | ||
| "signed_request_object", | ||
| "client_authentication_methods", | ||
| } | ||
|
|
||
| for _, field := range fieldsToRemove { | ||
| delete(clientSchema, field) | ||
| } | ||
|
|
||
| return clientSchema | ||
| } | ||
|
|
||
| func readClientsForDataSource(ctx context.Context, data *schema.ResourceData, meta interface{}) diag.Diagnostics { | ||
| api := meta.(*config.Config).GetAPI() | ||
|
|
||
| nameFilter := data.Get("name_filter").(string) | ||
| appTypesSet := data.Get("app_types").(*schema.Set) | ||
| isFirstParty := data.Get("is_first_party").(bool) | ||
|
|
||
| appTypes := make([]string, 0, appTypesSet.Len()) | ||
| for _, v := range appTypesSet.List() { | ||
| appTypes = append(appTypes, v.(string)) | ||
| } | ||
|
|
||
| var clients []*management.Client | ||
|
|
||
| params := []management.RequestOption{ | ||
| management.PerPage(100), | ||
| } | ||
|
|
||
| if len(appTypes) > 0 { | ||
| params = append(params, management.Parameter("app_type", strings.Join(appTypes, ","))) | ||
| } | ||
| if isFirstParty { | ||
| params = append(params, management.Parameter("is_first_party", "true")) | ||
| } | ||
|
|
||
| var page int | ||
| for { | ||
| // Add current page parameter | ||
| params = append(params, management.Page(page)) | ||
|
|
||
| list, err := api.Client.List(ctx, params...) | ||
| if err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
|
|
||
| for _, client := range list.Clients { | ||
| if nameFilter == "" || strings.Contains(client.GetName(), nameFilter) { | ||
| clients = append(clients, client) | ||
| } | ||
| } | ||
|
|
||
| if !list.HasNext() { | ||
| break | ||
| } | ||
|
|
||
| // Remove the page parameter and increment for next iteration | ||
| params = params[:len(params)-1] | ||
| page++ | ||
| } | ||
|
|
||
| filterID := generateFilterID(nameFilter, appTypes, isFirstParty) | ||
| data.SetId(filterID) | ||
|
|
||
| if err := flattenClientList(data, clients); err != nil { | ||
| return diag.FromErr(err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
|
|
||
| func generateFilterID(nameFilter string, appTypes []string, isFirstParty bool) string { | ||
| h := sha256.New() | ||
| h.Write([]byte(fmt.Sprintf("%s-%v-%v", nameFilter, appTypes, isFirstParty))) | ||
| return fmt.Sprintf("clients-%x", h.Sum(nil)) | ||
| } | ||
Oops, something went wrong.