fix(api): naming cleanup in user and session service (#6379)

* fix(api): rename first and last name to given and family name, intent to idp_intent, remove _ actions

* fix merge

* fully rename intent to idp intent in api

---------

Co-authored-by: Tim Möhlmann <tim+github@zitadel.com>

internal/api/grpc/user/v2/user.go

@@ -72,8 +72,8 @@ func AddUserRequestToAddHuman(req *user.AddHumanUserRequest) (*command.AddHuman,
 	return &command.AddHuman{
 		ID:          req.GetUserId(),
 		Username:    username,
-		FirstName:   req.GetProfile().GetFirstName(),
-		LastName:    req.GetProfile().GetLastName(),
+		FirstName:   req.GetProfile().GetGivenName(),
+		LastName:    req.GetProfile().GetFamilyName(),
 		NickName:    req.GetProfile().GetNickName(),
 		DisplayName: req.GetProfile().GetDisplayName(),
 		Email: command.Email{
@@ -129,18 +129,18 @@ func (s *Server) AddIDPLink(ctx context.Context, req *user.AddIDPLinkRequest) (_
 	}, nil
 }
 
-func (s *Server) StartIdentityProviderFlow(ctx context.Context, req *user.StartIdentityProviderFlowRequest) (_ *user.StartIdentityProviderFlowResponse, err error) {
+func (s *Server) StartIdentityProviderIntent(ctx context.Context, req *user.StartIdentityProviderIntentRequest) (_ *user.StartIdentityProviderIntentResponse, err error) {
 	switch t := req.GetContent().(type) {
-	case *user.StartIdentityProviderFlowRequest_Urls:
+	case *user.StartIdentityProviderIntentRequest_Urls:
 		return s.startIDPIntent(ctx, req.GetIdpId(), t.Urls)
-	case *user.StartIdentityProviderFlowRequest_Ldap:
+	case *user.StartIdentityProviderIntentRequest_Ldap:
 		return s.startLDAPIntent(ctx, req.GetIdpId(), t.Ldap)
 	default:
-		return nil, errors.ThrowUnimplementedf(nil, "USERv2-S2g21", "type oneOf %T in method StartIdentityProviderFlow not implemented", t)
+		return nil, errors.ThrowUnimplementedf(nil, "USERv2-S2g21", "type oneOf %T in method StartIdentityProviderIntent not implemented", t)
 	}
 }
 
-func (s *Server) startIDPIntent(ctx context.Context, idpID string, urls *user.RedirectURLs) (*user.StartIdentityProviderFlowResponse, error) {
+func (s *Server) startIDPIntent(ctx context.Context, idpID string, urls *user.RedirectURLs) (*user.StartIdentityProviderIntentResponse, error) {
 	intentWriteModel, details, err := s.command.CreateIntent(ctx, idpID, urls.GetSuccessUrl(), urls.GetFailureUrl(), authz.GetCtxData(ctx).OrgID)
 	if err != nil {
 		return nil, err
@@ -149,13 +149,13 @@ func (s *Server) startIDPIntent(ctx context.Context, idpID string, urls *user.Re
 	if err != nil {
 		return nil, err
 	}
-	return &user.StartIdentityProviderFlowResponse{
+	return &user.StartIdentityProviderIntentResponse{
 		Details:  object.DomainToDetailsPb(details),
-		NextStep: &user.StartIdentityProviderFlowResponse_AuthUrl{AuthUrl: authURL},
+		NextStep: &user.StartIdentityProviderIntentResponse_AuthUrl{AuthUrl: authURL},
 	}, nil
 }
 
-func (s *Server) startLDAPIntent(ctx context.Context, idpID string, ldapCredentials *user.LDAPCredentials) (*user.StartIdentityProviderFlowResponse, error) {
+func (s *Server) startLDAPIntent(ctx context.Context, idpID string, ldapCredentials *user.LDAPCredentials) (*user.StartIdentityProviderIntentResponse, error) {
 	intentWriteModel, details, err := s.command.CreateIntent(ctx, idpID, "", "", authz.GetCtxData(ctx).OrgID)
 	if err != nil {
 		return nil, err
@@ -171,9 +171,9 @@ func (s *Server) startLDAPIntent(ctx context.Context, idpID string, ldapCredenti
 	if err != nil {
 		return nil, err
 	}
-	return &user.StartIdentityProviderFlowResponse{
+	return &user.StartIdentityProviderIntentResponse{
 		Details:  object.DomainToDetailsPb(details),
-		NextStep: &user.StartIdentityProviderFlowResponse_Intent{Intent: &user.Intent{IntentId: intentWriteModel.AggregateID, Token: token}},
+		NextStep: &user.StartIdentityProviderIntentResponse_IdpIntent{IdpIntent: &user.IDPIntent{IdpIntentId: intentWriteModel.AggregateID, IdpIntentToken: token}},
 	}, nil
 }
 
@@ -228,27 +228,27 @@ func (s *Server) ldapLogin(ctx context.Context, idpID, username, password string
 	return externalUser, userID, attributes, nil
 }
 
-func (s *Server) RetrieveIdentityProviderInformation(ctx context.Context, req *user.RetrieveIdentityProviderInformationRequest) (_ *user.RetrieveIdentityProviderInformationResponse, err error) {
-	intent, err := s.command.GetIntentWriteModel(ctx, req.GetIntentId(), authz.GetCtxData(ctx).OrgID)
+func (s *Server) RetrieveIdentityProviderIntent(ctx context.Context, req *user.RetrieveIdentityProviderIntentRequest) (_ *user.RetrieveIdentityProviderIntentResponse, err error) {
+	intent, err := s.command.GetIntentWriteModel(ctx, req.GetIdpIntentId(), authz.GetCtxData(ctx).OrgID)
 	if err != nil {
 		return nil, err
 	}
-	if err := s.checkIntentToken(req.GetToken(), intent.AggregateID); err != nil {
+	if err := s.checkIntentToken(req.GetIdpIntentToken(), intent.AggregateID); err != nil {
 		return nil, err
 	}
 	if intent.State != domain.IDPIntentStateSucceeded {
 		return nil, errors.ThrowPreconditionFailed(nil, "IDP-Hk38e", "Errors.Intent.NotSucceeded")
 	}
-	return intentToIDPInformationPb(intent, s.idpAlg)
+	return idpIntentToIDPIntentPb(intent, s.idpAlg)
 }
 
-func intentToIDPInformationPb(intent *command.IDPIntentWriteModel, alg crypto.EncryptionAlgorithm) (_ *user.RetrieveIdentityProviderInformationResponse, err error) {
+func idpIntentToIDPIntentPb(intent *command.IDPIntentWriteModel, alg crypto.EncryptionAlgorithm) (_ *user.RetrieveIdentityProviderIntentResponse, err error) {
 	rawInformation := new(structpb.Struct)
 	err = rawInformation.UnmarshalJSON(intent.IDPUser)
 	if err != nil {
 		return nil, err
 	}
-	information := &user.RetrieveIdentityProviderInformationResponse{
+	information := &user.RetrieveIdentityProviderIntentResponse{
 		Details: intentToDetailsPb(intent),
 		IdpInformation: &user.IDPInformation{
 			IdpId:          intent.IDPID,

internal/api/grpc/user/v2/user_integration_test.go

@@ -67,8 +67,8 @@ func TestServer_AddHumanUser(t *testing.T) {
 						},
 					},
 					Profile: &user.SetHumanProfile{
-						FirstName:         "Donald",
-						LastName:          "Duck",
+						GivenName:         "Donald",
+						FamilyName:        "Duck",
 						NickName:          gu.Ptr("Dukkie"),
 						DisplayName:       gu.Ptr("Donald Duck"),
 						PreferredLanguage: gu.Ptr("en"),
@@ -108,8 +108,8 @@ func TestServer_AddHumanUser(t *testing.T) {
 						},
 					},
 					Profile: &user.SetHumanProfile{
-						FirstName:         "Donald",
-						LastName:          "Duck",
+						GivenName:         "Donald",
+						FamilyName:        "Duck",
 						NickName:          gu.Ptr("Dukkie"),
 						DisplayName:       gu.Ptr("Donald Duck"),
 						PreferredLanguage: gu.Ptr("en"),
@@ -153,8 +153,8 @@ func TestServer_AddHumanUser(t *testing.T) {
 						},
 					},
 					Profile: &user.SetHumanProfile{
-						FirstName:         "Donald",
-						LastName:          "Duck",
+						GivenName:         "Donald",
+						FamilyName:        "Duck",
 						NickName:          gu.Ptr("Dukkie"),
 						DisplayName:       gu.Ptr("Donald Duck"),
 						PreferredLanguage: gu.Ptr("en"),
@@ -199,8 +199,8 @@ func TestServer_AddHumanUser(t *testing.T) {
 						},
 					},
 					Profile: &user.SetHumanProfile{
-						FirstName:         "Donald",
-						LastName:          "Duck",
+						GivenName:         "Donald",
+						FamilyName:        "Duck",
 						NickName:          gu.Ptr("Dukkie"),
 						DisplayName:       gu.Ptr("Donald Duck"),
 						PreferredLanguage: gu.Ptr("en"),
@@ -246,8 +246,8 @@ func TestServer_AddHumanUser(t *testing.T) {
 						},
 					},
 					Profile: &user.SetHumanProfile{
-						FirstName:         "Donald",
-						LastName:          "Duck",
+						GivenName:         "Donald",
+						FamilyName:        "Duck",
 						NickName:          gu.Ptr("Dukkie"),
 						DisplayName:       gu.Ptr("Donald Duck"),
 						PreferredLanguage: gu.Ptr("en"),
@@ -318,8 +318,8 @@ func TestServer_AddHumanUser(t *testing.T) {
 						},
 					},
 					Profile: &user.SetHumanProfile{
-						FirstName:         "Donald",
-						LastName:          "Duck",
+						GivenName:         "Donald",
+						FamilyName:        "Duck",
 						NickName:          gu.Ptr("Dukkie"),
 						DisplayName:       gu.Ptr("Donald Duck"),
 						PreferredLanguage: gu.Ptr("en"),
@@ -352,8 +352,8 @@ func TestServer_AddHumanUser(t *testing.T) {
 						},
 					},
 					Profile: &user.SetHumanProfile{
-						FirstName:         "Donald",
-						LastName:          "Duck",
+						GivenName:         "Donald",
+						FamilyName:        "Duck",
 						NickName:          gu.Ptr("Dukkie"),
 						DisplayName:       gu.Ptr("Donald Duck"),
 						PreferredLanguage: gu.Ptr("en"),
@@ -399,8 +399,8 @@ func TestServer_AddHumanUser(t *testing.T) {
 						},
 					},
 					Profile: &user.SetHumanProfile{
-						FirstName:         "Donald",
-						LastName:          "Duck",
+						GivenName:         "Donald",
+						FamilyName:        "Duck",
 						NickName:          gu.Ptr("Dukkie"),
 						DisplayName:       gu.Ptr("Donald Duck"),
 						PreferredLanguage: gu.Ptr("en"),
@@ -451,8 +451,8 @@ func TestServer_AddHumanUser(t *testing.T) {
 						},
 					},
 					Profile: &user.SetHumanProfile{
-						FirstName:         "Donald",
-						LastName:          "Duck",
+						GivenName:         "Donald",
+						FamilyName:        "Duck",
 						NickName:          gu.Ptr("Dukkie"),
 						DisplayName:       gu.Ptr("Donald Duck"),
 						PreferredLanguage: gu.Ptr("en"),
@@ -490,8 +490,8 @@ func TestServer_AddHumanUser(t *testing.T) {
 						},
 					},
 					Profile: &user.SetHumanProfile{
-						FirstName:         "Donald",
-						LastName:          "Duck",
+						GivenName:         "Donald",
+						FamilyName:        "Duck",
 						NickName:          gu.Ptr("Dukkie"),
 						DisplayName:       gu.Ptr("Donald Duck"),
 						PreferredLanguage: gu.Ptr("en"),
@@ -622,23 +622,23 @@ func TestServer_AddIDPLink(t *testing.T) {
 	}
 }
 
-func TestServer_StartIdentityProviderFlow(t *testing.T) {
+func TestServer_StartIdentityProviderIntent(t *testing.T) {
 	idpID := Tester.AddGenericOAuthProvider(t)
 	type args struct {
 		ctx context.Context
-		req *user.StartIdentityProviderFlowRequest
+		req *user.StartIdentityProviderIntentRequest
 	}
 	tests := []struct {
 		name    string
 		args    args
-		want    *user.StartIdentityProviderFlowResponse
+		want    *user.StartIdentityProviderIntentResponse
 		wantErr bool
 	}{
 		{
 			name: "missing urls",
 			args: args{
 				CTX,
-				&user.StartIdentityProviderFlowRequest{
+				&user.StartIdentityProviderIntentRequest{
 					IdpId: idpID,
 				},
 			},
@@ -649,9 +649,9 @@ func TestServer_StartIdentityProviderFlow(t *testing.T) {
 			name: "next step auth url",
 			args: args{
 				CTX,
-				&user.StartIdentityProviderFlowRequest{
+				&user.StartIdentityProviderIntentRequest{
 					IdpId: idpID,
-					Content: &user.StartIdentityProviderFlowRequest_Urls{
+					Content: &user.StartIdentityProviderIntentRequest_Urls{
 						Urls: &user.RedirectURLs{
 							SuccessUrl: "https://example.com/success",
 							FailureUrl: "https://example.com/failure",
@@ -659,12 +659,12 @@ func TestServer_StartIdentityProviderFlow(t *testing.T) {
 					},
 				},
 			},
-			want: &user.StartIdentityProviderFlowResponse{
+			want: &user.StartIdentityProviderIntentResponse{
 				Details: &object.Details{
 					ChangeDate:    timestamppb.Now(),
 					ResourceOwner: Tester.Organisation.ID,
 				},
-				NextStep: &user.StartIdentityProviderFlowResponse_AuthUrl{
+				NextStep: &user.StartIdentityProviderIntentResponse_AuthUrl{
 					AuthUrl: "https://example.com/oauth/v2/authorize?client_id=clientID&prompt=select_account&redirect_uri=http%3A%2F%2Flocalhost%3A8080%2Fidps%2Fcallback&response_type=code&scope=openid+profile+email&state=",
 				},
 			},
@@ -673,7 +673,7 @@ func TestServer_StartIdentityProviderFlow(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got, err := Client.StartIdentityProviderFlow(tt.args.ctx, tt.args.req)
+			got, err := Client.StartIdentityProviderIntent(tt.args.ctx, tt.args.req)
 			if tt.wantErr {
 				require.Error(t, err)
 			} else {
@@ -690,28 +690,28 @@ func TestServer_StartIdentityProviderFlow(t *testing.T) {
 	}
 }
 
-func TestServer_RetrieveIdentityProviderInformation(t *testing.T) {
+func TestServer_RetrieveIdentityProviderIntent(t *testing.T) {
 	idpID := Tester.AddGenericOAuthProvider(t)
 	intentID := Tester.CreateIntent(t, idpID)
 	successfulID, token, changeDate, sequence := Tester.CreateSuccessfulOAuthIntent(t, idpID, "", "id")
 	ldapSuccessfulID, ldapToken, ldapChangeDate, ldapSequence := Tester.CreateSuccessfulLDAPIntent(t, idpID, "", "id")
 	type args struct {
 		ctx context.Context
-		req *user.RetrieveIdentityProviderInformationRequest
+		req *user.RetrieveIdentityProviderIntentRequest
 	}
 	tests := []struct {
 		name    string
 		args    args
-		want    *user.RetrieveIdentityProviderInformationResponse
+		want    *user.RetrieveIdentityProviderIntentResponse
 		wantErr bool
 	}{
 		{
 			name: "failed intent",
 			args: args{
 				CTX,
-				&user.RetrieveIdentityProviderInformationRequest{
-					IntentId: intentID,
-					Token:    "",
+				&user.RetrieveIdentityProviderIntentRequest{
+					IdpIntentId:    intentID,
+					IdpIntentToken: "",
 				},
 			},
 			wantErr: true,
@@ -720,9 +720,9 @@ func TestServer_RetrieveIdentityProviderInformation(t *testing.T) {
 			name: "wrong token",
 			args: args{
 				CTX,
-				&user.RetrieveIdentityProviderInformationRequest{
-					IntentId: successfulID,
-					Token:    "wrong token",
+				&user.RetrieveIdentityProviderIntentRequest{
+					IdpIntentId:    successfulID,
+					IdpIntentToken: "wrong token",
 				},
 			},
 			wantErr: true,
@@ -731,12 +731,12 @@ func TestServer_RetrieveIdentityProviderInformation(t *testing.T) {
 			name: "retrieve successful intent",
 			args: args{
 				CTX,
-				&user.RetrieveIdentityProviderInformationRequest{
-					IntentId: successfulID,
-					Token:    token,
+				&user.RetrieveIdentityProviderIntentRequest{
+					IdpIntentId:    successfulID,
+					IdpIntentToken: token,
 				},
 			},
-			want: &user.RetrieveIdentityProviderInformationResponse{
+			want: &user.RetrieveIdentityProviderIntentResponse{
 				Details: &object.Details{
 					ChangeDate:    timestamppb.New(changeDate),
 					ResourceOwner: Tester.Organisation.ID,
@@ -768,12 +768,12 @@ func TestServer_RetrieveIdentityProviderInformation(t *testing.T) {
 			name: "retrieve successful ldap intent",
 			args: args{
 				CTX,
-				&user.RetrieveIdentityProviderInformationRequest{
-					IntentId: ldapSuccessfulID,
-					Token:    ldapToken,
+				&user.RetrieveIdentityProviderIntentRequest{
+					IdpIntentId:    ldapSuccessfulID,
+					IdpIntentToken: ldapToken,
 				},
 			},
-			want: &user.RetrieveIdentityProviderInformationResponse{
+			want: &user.RetrieveIdentityProviderIntentResponse{
 				Details: &object.Details{
 					ChangeDate:    timestamppb.New(ldapChangeDate),
 					ResourceOwner: Tester.Organisation.ID,
@@ -812,7 +812,7 @@ func TestServer_RetrieveIdentityProviderInformation(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got, err := Client.RetrieveIdentityProviderInformation(tt.args.ctx, tt.args.req)
+			got, err := Client.RetrieveIdentityProviderIntent(tt.args.ctx, tt.args.req)
 			if tt.wantErr {
 				require.Error(t, err)
 			} else {

internal/api/grpc/user/v2/user_test.go

@@ -24,7 +24,7 @@ import (
 
 var ignoreTypes = []protoreflect.FullName{"google.protobuf.Duration", "google.protobuf.Struct"}
 
-func Test_intentToIDPInformationPb(t *testing.T) {
+func Test_idpIntentToIDPIntentPb(t *testing.T) {
 	decryption := func(err error) crypto.EncryptionAlgorithm {
 		mCrypto := crypto.NewMockEncryptionAlgorithm(gomock.NewController(t))
 		mCrypto.EXPECT().Algorithm().Return("enc")
@@ -44,7 +44,7 @@ func Test_intentToIDPInformationPb(t *testing.T) {
 		alg    crypto.EncryptionAlgorithm
 	}
 	type res struct {
-		resp *user.RetrieveIdentityProviderInformationResponse
+		resp *user.RetrieveIdentityProviderIntentResponse
 		err  error
 	}
 	tests := []struct {
@@ -113,7 +113,7 @@ func Test_intentToIDPInformationPb(t *testing.T) {
 				alg: decryption(nil),
 			},
 			res{
-				resp: &user.RetrieveIdentityProviderInformationResponse{
+				resp: &user.RetrieveIdentityProviderIntentResponse{
 					Details: &object_pb.Details{
 						Sequence:      123,
 						ChangeDate:    timestamppb.New(time.Date(2019, 4, 1, 1, 1, 1, 1, time.Local)),
@@ -166,7 +166,7 @@ func Test_intentToIDPInformationPb(t *testing.T) {
 				},
 			},
 			res{
-				resp: &user.RetrieveIdentityProviderInformationResponse{
+				resp: &user.RetrieveIdentityProviderIntentResponse{
 					Details: &object_pb.Details{
 						Sequence:      123,
 						ChangeDate:    timestamppb.New(time.Date(2019, 4, 1, 1, 1, 1, 1, time.Local)),
@@ -205,7 +205,7 @@ func Test_intentToIDPInformationPb(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got, err := intentToIDPInformationPb(tt.args.intent, tt.args.alg)
+			got, err := idpIntentToIDPIntentPb(tt.args.intent, tt.args.alg)
 			require.ErrorIs(t, err, tt.res.err)
 			grpc.AllFieldsEqual(t, tt.res.resp.ProtoReflect(), got.ProtoReflect(), grpc.CustomMappers)
 		})