Can't round-trip fields from `management.UserIdentitySchema` to `management.Identity`

[haines]

Checklist

• I have looked into the README and have not found a suitable solution or answer.
• I have looked into the documentation and have not found a suitable solution or answer.
• I have searched the issues and have not found a suitable solution or answer.
• I have upgraded to the latest version of this SDK and the issue still persists.
• I have searched the Auth0 Community forums and have not found a suitable solution or answer.
• I agree to the terms within the Auth0 Code of Conduct.

Description

management.UserIdentitySchema now has a UserID field of type *management.UserID, but management.Identity's UserID is of type string.

That makes it awkward to get a user identity's ID from one API call and pass it into another.

Also, the Provider fields have different types, even though they appear to be equivalent enums.

Expectation

User identities have consistently-typed fields so that you can round-trip them easily.

Reproduction

package users

import (
	"context"
	"fmt"

	"github.com/auth0/go-auth0/v2/management"
	"github.com/auth0/go-auth0/v2/management/client"
)

func resendVerificationEmail(ctx context.Context, id string) error {
	auth0, err := client.New("...")
	if err != nil {
		return err
	}

	user, err := auth0.Users.Get(ctx, id, &management.GetUserRequestParameters{
		Fields:        new("identities"),
		IncludeFields: new(true),
	})
	if err != nil {
		return err
	}

	if len(user.Identities) != 1 {
		return fmt.Errorf("user %w has %d identities", len(user.Identities))
	}

	identity := user.Identities[0]

	_, err = auth0.Jobs.VerificationEmail.Create(ctx, &management.CreateVerificationEmailRequestContent{
		ClientID: new("..."),
		UserID:   id,
		Identity: &management.Identity{
			// cannot use identity.GetProvider() (value of string type management.UserIdentityProviderEnum) as management.IdentityProviderEnum value in struct literal
			Provider: identity.GetProvider(),

			// cannot use identity.GetUserID() (value of struct type management.UserID) as string value in struct literal
			UserID: identity.GetUserID(),
		},
	})
	return err
}

Auth0 Go SDK version

v2.14.0

[developerkunal]

Hey @haines,

Thank you for opening this issue! Let me take a look, and I will get back to you with an update.

[developerkunal]

Hey @haines,

Thanks for the detailed write up and the clear reproduction, that really helped.

You're right that the fields don't line up across the read and write models. When you read a user, each identity comes back as management.UserIdentitySchema, where UserID is a *management.UserID union and Provider is a management.UserIdentityProviderEnum. The write side, management.Identity, expects a plain string for UserID and a management.IdentityProviderEnum for Provider. The two enums carry the same underlying values but they're distinct named types, so Go won't let you assign one to the other, and the UserID union isn't a string either.

This comes from how these models are typed in the API definition that generates the SDK, so I'm looking into it with the API team to get the types unified properly upstream. I'll come back here with an update once I know more.

In the meantime, here's a workaround that compiles and runs today. The enum is a straight named-string conversion since the members are identical, and the UserID union just needs to be flattened to a string:

import "strconv"

identity := user.Identities[0]

_, err = auth0.Jobs.VerificationEmail.Create(ctx, &management.CreateVerificationEmailRequestContent{
    ClientID: management.String("..."),
    UserID:   id,
    Identity: &management.Identity{
        // Both enums are `type ... string` with identical members,
        // so a direct conversion is safe.
        Provider: management.IdentityProviderEnum(identity.GetProvider()),

        // Flatten the string|integer union to a string.
        UserID: userIDToString(identity.GetUserID()),
    },
})

// ...

// userIDToString flattens the management.UserID string|integer union into a
// plain string for the write-side Identity model.
func userIDToString(uid management.UserID) string {
    if s := uid.GetString(); s != "" {
        return s
    }
    if n := uid.GetInteger(); n != 0 {
        return strconv.Itoa(n)
    }
    return ""
}

Hope that unblocks you for now, and thanks again for flagging it.