Skip to content

feat: add --name-id-format flag to sso add and sso update #4477

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
merged 2 commits into from
Nov 24, 2025
+41 −0
Merged

feat: add --name-id-format flag to sso add and sso update #4477

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c0adae
feat: add `--name-id-format` flag to `sso add` and `sso update`
hf Nov 20, 2025
c380f11
chore: use type constants
sweatybridge Nov 24, 2025
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
15 changes: 15 additions & 0 deletions cmd/sso.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/supabase/cli/internal/sso/update"
"github.com/supabase/cli/internal/utils"
"github.com/supabase/cli/internal/utils/flags"
"github.com/supabase/cli/pkg/api"
)

var (
Expand All @@ -25,6 +26,16 @@ var (
Allowed: []string{"saml"},
// intentionally no default value so users have to specify --type saml explicitly
}

ssoNameIDFormat = utils.EnumFlag{
Allowed: []string{
string(api.CreateProviderBodyNameIdFormatUrnOasisNamesTcSAML11NameidFormatEmailAddress),
string(api.CreateProviderBodyNameIdFormatUrnOasisNamesTcSAML11NameidFormatUnspecified),
string(api.CreateProviderBodyNameIdFormatUrnOasisNamesTcSAML20NameidFormatPersistent),
string(api.CreateProviderBodyNameIdFormatUrnOasisNamesTcSAML20NameidFormatTransient),
},
}

ssoMetadataFile string
ssoMetadataURL string
ssoSkipURLValidation bool
Expand All @@ -48,6 +59,7 @@ var (
MetadataURL: ssoMetadataURL,
SkipURLValidation: ssoSkipURLValidation,
AttributeMapping: ssoAttributeMappingFile,
NameIDFormat: ssoNameIDFormat.String(),
Domains: ssoDomains,
})
},
Expand Down Expand Up @@ -88,6 +100,7 @@ var (
MetadataURL: ssoMetadataURL,
SkipURLValidation: ssoSkipURLValidation,
AttributeMapping: ssoAttributeMappingFile,
NameIDFormat: ssoNameIDFormat.String(),
Domains: ssoDomains,
AddDomains: ssoAddDomains,
RemoveDomains: ssoRemoveDomains,
Expand Down Expand Up @@ -146,6 +159,7 @@ func init() {
ssoAddFlags.StringVar(&ssoMetadataURL, "metadata-url", "", "URL pointing to a SAML 2.0 Metadata XML document describing the identity provider.")
ssoAddFlags.BoolVar(&ssoSkipURLValidation, "skip-url-validation", false, "Whether local validation of the SAML 2.0 Metadata URL should not be performed.")
ssoAddFlags.StringVar(&ssoAttributeMappingFile, "attribute-mapping-file", "", "File containing a JSON mapping between SAML attributes to custom JWT claims.")
ssoAddFlags.Var(&ssoNameIDFormat, "name-id-format", "URI reference representing the classification of string-based identifier information.")
ssoAddCmd.MarkFlagsMutuallyExclusive("metadata-file", "metadata-url")
cobra.CheckErr(ssoAddCmd.MarkFlagRequired("type"))
cobra.CheckErr(ssoAddCmd.MarkFlagFilename("metadata-file", "xml"))
Expand All @@ -159,6 +173,7 @@ func init() {
ssoUpdateFlags.StringVar(&ssoMetadataURL, "metadata-url", "", "URL pointing to a SAML 2.0 Metadata XML document describing the identity provider.")
ssoUpdateFlags.BoolVar(&ssoSkipURLValidation, "skip-url-validation", false, "Whether local validation of the SAML 2.0 Metadata URL should not be performed.")
ssoUpdateFlags.StringVar(&ssoAttributeMappingFile, "attribute-mapping-file", "", "File containing a JSON mapping between SAML attributes to custom JWT claims.")
ssoUpdateFlags.Var(&ssoNameIDFormat, "name-id-format", "URI reference representing the classification of string-based identifier information.")
ssoUpdateCmd.MarkFlagsMutuallyExclusive("metadata-file", "metadata-url")
ssoUpdateCmd.MarkFlagsMutuallyExclusive("domains", "add-domains")
ssoUpdateCmd.MarkFlagsMutuallyExclusive("domains", "remove-domains")
Expand Down
6 changes: 6 additions & 0 deletions internal/sso/create/create.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import (
"github.com/supabase/cli/internal/sso/internal/saml"
"github.com/supabase/cli/internal/utils"
"github.com/supabase/cli/pkg/api"
"github.com/supabase/cli/pkg/cast"
)

var Fs = afero.NewOsFs()
Expand All @@ -25,6 +26,7 @@ type RunParams struct {
MetadataURL string
SkipURLValidation bool
AttributeMapping string
NameIDFormat string
}

func Run(ctx context.Context, params RunParams) error {
Expand Down Expand Up @@ -66,6 +68,10 @@ func Run(ctx context.Context, params RunParams) error {
body.Domains = &params.Domains
}

if params.NameIDFormat != "" {
body.NameIdFormat = cast.Ptr(api.CreateProviderBodyNameIdFormat(params.NameIDFormat))
}

resp, err := utils.GetSupabase().V1CreateASsoProviderWithResponse(ctx, params.ProjectRef, body)
if err != nil {
return errors.Errorf("failed to create sso provider: %w", err)
Expand Down
14 changes: 14 additions & 0 deletions internal/sso/internal/render/render.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,15 @@ func formatEntityID(provider api.GetProviderResponse) string {
return entityID
}

func formatNameIDFormat(provider api.GetProviderResponse) string {
nameIDFormat := "-"
if provider.Saml != nil && provider.Saml.NameIdFormat != nil && *provider.Saml.NameIdFormat != "" {
nameIDFormat = *provider.Saml.NameIdFormat
}

return nameIDFormat
}

func ListMarkdown(providers api.ListProvidersResponse) error {
markdownTable := []string{
"|TYPE|IDENTITY PROVIDER ID|DOMAINS|SAML 2.0 `EntityID`|CREATED AT (UTC)|UPDATED AT (UTC)|\n|-|-|-|-|-|-|\n",
Expand Down Expand Up @@ -116,6 +125,11 @@ func SingleMarkdown(provider api.GetProviderResponse) error {
"|SAML 2.0 `EntityID`|`%s`|",
formatEntityID(provider),
))

markdownTable = append(markdownTable, fmt.Sprintf(
"|NAMEID FORMAT|`%s`|",
formatNameIDFormat(provider),
))
}

markdownTable = append(markdownTable, fmt.Sprintf(
Expand Down
6 changes: 6 additions & 0 deletions internal/sso/update/update.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/supabase/cli/internal/sso/internal/saml"
"github.com/supabase/cli/internal/utils"
"github.com/supabase/cli/pkg/api"
"github.com/supabase/cli/pkg/cast"
)

var Fs = afero.NewOsFs()
Expand All @@ -25,6 +26,7 @@ type RunParams struct {
MetadataURL string
SkipURLValidation bool
AttributeMapping string
NameIDFormat string

Domains []string
AddDomains []string
Expand Down Expand Up @@ -111,6 +113,10 @@ func Run(ctx context.Context, params RunParams) error {
body.Domains = &domains
}

if params.NameIDFormat != "" {
body.NameIdFormat = cast.Ptr(api.UpdateProviderBodyNameIdFormat(params.NameIDFormat))
}

putResp, err := utils.GetSupabase().V1UpdateASsoProviderWithResponse(ctx, params.ProjectRef, parsed, body)
if err != nil {
return errors.Errorf("failed to update sso provider: %w", err)
Expand Down
Loading